Skip to content

Commit 23e657c

Browse files
thewh1teaglethewh1teagle
committed
init
0 parents  commit 23e657c

File tree

9 files changed

+1712
-0
lines changed

9 files changed

+1712
-0
lines changed

‎.github/workflows/release.yml

+291
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,291 @@
1+
# This file was autogenerated by dist: https://opensource.axo.dev/cargo-dist/
2+
#
3+
# Copyright 2022-2024, axodotdev
4+
# SPDX-License-Identifier: MIT or Apache-2.0
5+
#
6+
# CI that:
7+
#
8+
# * checks for a Git Tag that looks like a release
9+
# * builds artifacts with dist (archives, installers, hashes)
10+
# * uploads those artifacts to temporary workflow zip
11+
# * on success, uploads the artifacts to a GitHub Release
12+
#
13+
# Note that the GitHub Release will be created with a generated
14+
# title/body based on your changelogs.
15+
16+
name: Release
17+
permissions:
18+
"contents": "write"
19+
20+
# This task will run whenever you push a git tag that looks like a version
21+
# like "1.0.0", "v0.1.0-prerelease.1", "my-app/0.1.0", "releases/v1.0.0", etc.
22+
# Various formats will be parsed into a VERSION and an optional PACKAGE_NAME, where
23+
# PACKAGE_NAME must be the name of a Cargo package in your workspace, and VERSION
24+
# must be a Cargo-style SemVer Version (must have at least major.minor.patch).
25+
#
26+
# If PACKAGE_NAME is specified, then the announcement will be for that
27+
# package (erroring out if it doesn't have the given version or isn't dist-able).
28+
#
29+
# If PACKAGE_NAME isn't specified, then the announcement will be for all
30+
# (dist-able) packages in the workspace with that version (this mode is
31+
# intended for workspaces with only one dist-able package, or with all dist-able
32+
# packages versioned/released in lockstep).
33+
#
34+
# If you push multiple tags at once, separate instances of this workflow will
35+
# spin up, creating an independent announcement for each one. However, GitHub
36+
# will hard limit this to 3 tags per commit, as it will assume more tags is a
37+
# mistake.
38+
#
39+
# If there's a prerelease-style suffix to the version, then the release(s)
40+
# will be marked as a prerelease.
41+
on:
42+
pull_request:
43+
push:
44+
tags:
45+
- '**[0-9]+.[0-9]+.[0-9]+*'
46+
47+
jobs:
48+
# Run 'dist plan' (or host) to determine what tasks we need to do
49+
plan:
50+
runs-on: "ubuntu-20.04"
51+
outputs:
52+
val: ${{ steps.plan.outputs.manifest }}
53+
tag: ${{ !github.event.pull_request && github.ref_name || '' }}
54+
tag-flag: ${{ !github.event.pull_request && format('--tag={0}', github.ref_name) || '' }}
55+
publishing: ${{ !github.event.pull_request }}
56+
env:
57+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
58+
steps:
59+
- uses: actions/checkout@v4
60+
with:
61+
submodules: recursive
62+
- name: Install dist
63+
# we specify bash to get pipefail; it guards against the `curl` command
64+
# failing. otherwise `sh` won't catch that `curl` returned non-0
65+
shell: bash
66+
run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.26.1/cargo-dist-installer.sh | sh"
67+
- name: Cache dist
68+
uses: actions/upload-artifact@v4
69+
with:
70+
name: cargo-dist-cache
71+
path: ~/.cargo/bin/dist
72+
# sure would be cool if github gave us proper conditionals...
73+
# so here's a doubly-nested ternary-via-truthiness to try to provide the best possible
74+
# functionality based on whether this is a pull_request, and whether it's from a fork.
75+
# (PRs run on the *source* but secrets are usually on the *target* -- that's *good*
76+
# but also really annoying to build CI around when it needs secrets to work right.)
77+
- id: plan
78+
run: |
79+
dist ${{ (!github.event.pull_request && format('host --steps=create --tag={0}', github.ref_name)) || 'plan' }} --output-format=json > plan-dist-manifest.json
80+
echo "dist ran successfully"
81+
cat plan-dist-manifest.json
82+
echo "manifest=$(jq -c "." plan-dist-manifest.json)" >> "$GITHUB_OUTPUT"
83+
- name: "Upload dist-manifest.json"
84+
uses: actions/upload-artifact@v4
85+
with:
86+
name: artifacts-plan-dist-manifest
87+
path: plan-dist-manifest.json
88+
89+
# Build and packages all the platform-specific things
90+
build-local-artifacts:
91+
name: build-local-artifacts (${{ join(matrix.targets, ', ') }})
92+
# Let the initial task tell us to not run (currently very blunt)
93+
needs:
94+
- plan
95+
if: ${{ fromJson(needs.plan.outputs.val).ci.github.artifacts_matrix.include != null && (needs.plan.outputs.publishing == 'true' || fromJson(needs.plan.outputs.val).ci.github.pr_run_mode == 'upload') }}
96+
strategy:
97+
fail-fast: false
98+
# Target platforms/runners are computed by dist in create-release.
99+
# Each member of the matrix has the following arguments:
100+
#
101+
# - runner: the github runner
102+
# - dist-args: cli flags to pass to dist
103+
# - install-dist: expression to run to install dist on the runner
104+
#
105+
# Typically there will be:
106+
# - 1 "global" task that builds universal installers
107+
# - N "local" tasks that build each platform's binaries and platform-specific installers
108+
matrix: ${{ fromJson(needs.plan.outputs.val).ci.github.artifacts_matrix }}
109+
runs-on: ${{ matrix.runner }}
110+
container: ${{ matrix.container && matrix.container.image || null }}
111+
env:
112+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
113+
BUILD_MANIFEST_NAME: target/distrib/${{ join(matrix.targets, '-') }}-dist-manifest.json
114+
steps:
115+
- name: enable windows longpaths
116+
run: |
117+
git config --global core.longpaths true
118+
- uses: actions/checkout@v4
119+
with:
120+
submodules: recursive
121+
- name: Install Rust non-interactively if not already installed
122+
if: ${{ matrix.container }}
123+
run: |
124+
if ! command -v cargo > /dev/null 2>&1; then
125+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
126+
echo "$HOME/.cargo/bin" >> $GITHUB_PATH
127+
fi
128+
- name: Install dist
129+
run: ${{ matrix.install_dist.run }}
130+
# Get the dist-manifest
131+
- name: Fetch local artifacts
132+
uses: actions/download-artifact@v4
133+
with:
134+
pattern: artifacts-*
135+
path: target/distrib/
136+
merge-multiple: true
137+
- name: Install dependencies
138+
run: |
139+
${{ matrix.packages_install }}
140+
- name: Build artifacts
141+
run: |
142+
# Actually do builds and make zips and whatnot
143+
dist build ${{ needs.plan.outputs.tag-flag }} --print=linkage --output-format=json ${{ matrix.dist_args }} > dist-manifest.json
144+
echo "dist ran successfully"
145+
- id: cargo-dist
146+
name: Post-build
147+
# We force bash here just because github makes it really hard to get values up
148+
# to "real" actions without writing to env-vars, and writing to env-vars has
149+
# inconsistent syntax between shell and powershell.
150+
shell: bash
151+
run: |
152+
# Parse out what we just built and upload it to scratch storage
153+
echo "paths<<EOF" >> "$GITHUB_OUTPUT"
154+
dist print-upload-files-from-manifest --manifest dist-manifest.json >> "$GITHUB_OUTPUT"
155+
echo "EOF" >> "$GITHUB_OUTPUT"
156+
157+
cp dist-manifest.json "$BUILD_MANIFEST_NAME"
158+
- name: "Upload artifacts"
159+
uses: actions/upload-artifact@v4
160+
with:
161+
name: artifacts-build-local-${{ join(matrix.targets, '_') }}
162+
path: |
163+
${{ steps.cargo-dist.outputs.paths }}
164+
${{ env.BUILD_MANIFEST_NAME }}
165+
166+
# Build and package all the platform-agnostic(ish) things
167+
build-global-artifacts:
168+
needs:
169+
- plan
170+
- build-local-artifacts
171+
runs-on: "ubuntu-20.04"
172+
env:
173+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
174+
BUILD_MANIFEST_NAME: target/distrib/global-dist-manifest.json
175+
steps:
176+
- uses: actions/checkout@v4
177+
with:
178+
submodules: recursive
179+
- name: Install cached dist
180+
uses: actions/download-artifact@v4
181+
with:
182+
name: cargo-dist-cache
183+
path: ~/.cargo/bin/
184+
- run: chmod +x ~/.cargo/bin/dist
185+
# Get all the local artifacts for the global tasks to use (for e.g. checksums)
186+
- name: Fetch local artifacts
187+
uses: actions/download-artifact@v4
188+
with:
189+
pattern: artifacts-*
190+
path: target/distrib/
191+
merge-multiple: true
192+
- id: cargo-dist
193+
shell: bash
194+
run: |
195+
dist build ${{ needs.plan.outputs.tag-flag }} --output-format=json "--artifacts=global" > dist-manifest.json
196+
echo "dist ran successfully"
197+
198+
# Parse out what we just built and upload it to scratch storage
199+
echo "paths<<EOF" >> "$GITHUB_OUTPUT"
200+
jq --raw-output ".upload_files[]" dist-manifest.json >> "$GITHUB_OUTPUT"
201+
echo "EOF" >> "$GITHUB_OUTPUT"
202+
203+
cp dist-manifest.json "$BUILD_MANIFEST_NAME"
204+
- name: "Upload artifacts"
205+
uses: actions/upload-artifact@v4
206+
with:
207+
name: artifacts-build-global
208+
path: |
209+
${{ steps.cargo-dist.outputs.paths }}
210+
${{ env.BUILD_MANIFEST_NAME }}
211+
# Determines if we should publish/announce
212+
host:
213+
needs:
214+
- plan
215+
- build-local-artifacts
216+
- build-global-artifacts
217+
# Only run if we're "publishing", and only if local and global didn't fail (skipped is fine)
218+
if: ${{ always() && needs.plan.outputs.publishing == 'true' && (needs.build-global-artifacts.result == 'skipped' || needs.build-global-artifacts.result == 'success') && (needs.build-local-artifacts.result == 'skipped' || needs.build-local-artifacts.result == 'success') }}
219+
env:
220+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
221+
runs-on: "ubuntu-20.04"
222+
outputs:
223+
val: ${{ steps.host.outputs.manifest }}
224+
steps:
225+
- uses: actions/checkout@v4
226+
with:
227+
submodules: recursive
228+
- name: Install cached dist
229+
uses: actions/download-artifact@v4
230+
with:
231+
name: cargo-dist-cache
232+
path: ~/.cargo/bin/
233+
- run: chmod +x ~/.cargo/bin/dist
234+
# Fetch artifacts from scratch-storage
235+
- name: Fetch artifacts
236+
uses: actions/download-artifact@v4
237+
with:
238+
pattern: artifacts-*
239+
path: target/distrib/
240+
merge-multiple: true
241+
- id: host
242+
shell: bash
243+
run: |
244+
dist host ${{ needs.plan.outputs.tag-flag }} --steps=upload --steps=release --output-format=json > dist-manifest.json
245+
echo "artifacts uploaded and released successfully"
246+
cat dist-manifest.json
247+
echo "manifest=$(jq -c "." dist-manifest.json)" >> "$GITHUB_OUTPUT"
248+
- name: "Upload dist-manifest.json"
249+
uses: actions/upload-artifact@v4
250+
with:
251+
# Overwrite the previous copy
252+
name: artifacts-dist-manifest
253+
path: dist-manifest.json
254+
# Create a GitHub Release while uploading all files to it
255+
- name: "Download GitHub Artifacts"
256+
uses: actions/download-artifact@v4
257+
with:
258+
pattern: artifacts-*
259+
path: artifacts
260+
merge-multiple: true
261+
- name: Cleanup
262+
run: |
263+
# Remove the granular manifests
264+
rm -f artifacts/*-dist-manifest.json
265+
- name: Create GitHub Release
266+
env:
267+
PRERELEASE_FLAG: "${{ fromJson(steps.host.outputs.manifest).announcement_is_prerelease && '--prerelease' || '' }}"
268+
ANNOUNCEMENT_TITLE: "${{ fromJson(steps.host.outputs.manifest).announcement_title }}"
269+
ANNOUNCEMENT_BODY: "${{ fromJson(steps.host.outputs.manifest).announcement_github_body }}"
270+
RELEASE_COMMIT: "${{ github.sha }}"
271+
run: |
272+
# Write and read notes from a file to avoid quoting breaking things
273+
echo "$ANNOUNCEMENT_BODY" > $RUNNER_TEMP/notes.txt
274+
275+
gh release create "${{ needs.plan.outputs.tag }}" --target "$RELEASE_COMMIT" $PRERELEASE_FLAG --title "$ANNOUNCEMENT_TITLE" --notes-file "$RUNNER_TEMP/notes.txt" artifacts/*
276+
277+
announce:
278+
needs:
279+
- plan
280+
- host
281+
# use "always() && ..." to allow us to wait for all publish jobs while
282+
# still allowing individual publish jobs to skip themselves (for prereleases).
283+
# "host" however must run to completion, no skipping allowed!
284+
if: ${{ always() && needs.host.result == 'success' }}
285+
runs-on: "ubuntu-20.04"
286+
env:
287+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
288+
steps:
289+
- uses: actions/checkout@v4
290+
with:
291+
submodules: recursive

‎.github/workflows/web.yml

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Workflow to build your docs with oranda (and mdbook)
2+
# and deploy them to Github Pages
3+
name: Web
4+
5+
# We're going to push to the gh-pages branch, so we need that permission
6+
permissions:
7+
contents: write
8+
9+
# What situations do we want to build docs in?
10+
# All of these work independently and can be removed / commented out
11+
# if you don't want oranda/mdbook running in that situation
12+
on:
13+
# Check that a PR didn't break docs!
14+
#
15+
# Note that the "Deploy to Github Pages" step won't run in this mode,
16+
# so this won't have any side-effects. But it will tell you if a PR
17+
# completely broke oranda/mdbook. Sadly we don't provide previews (yet)!
18+
pull_request:
19+
20+
# Whenever something gets pushed to main, update the docs!
21+
# This is great for getting docs changes live without cutting a full release.
22+
#
23+
# Note that if you're using cargo-dist, this will "race" the Release workflow
24+
# that actually builds the Github Release that oranda tries to read (and
25+
# this will almost certainly complete first). As a result you will publish
26+
# docs for the latest commit but the oranda landing page won't know about
27+
# the latest release. The workflow_run trigger below will properly wait for
28+
# cargo-dist, and so this half-published state will only last for ~10 minutes.
29+
#
30+
# If you only want docs to update with releases, disable this, or change it to
31+
# a "release" branch. You can, of course, also manually trigger a workflow run
32+
# when you want the docs to update.
33+
push:
34+
branches:
35+
- main
36+
37+
# Whenever a workflow called "Release" completes, update the docs!
38+
#
39+
# If you're using cargo-dist, this is recommended, as it will ensure that
40+
# oranda always sees the latest release right when it's available. Note
41+
# however that Github's UI is wonky when you use workflow_run, and won't
42+
# show this workflow as part of any commit. You have to go to the "actions"
43+
# tab for your repo to see this one running (the gh-pages deploy will also
44+
# only show up there).
45+
workflow_run:
46+
workflows: [ "Release" ]
47+
types:
48+
- completed
49+
50+
# Alright, let's do it!
51+
jobs:
52+
web:
53+
name: Build and deploy site and docs
54+
runs-on: ubuntu-latest
55+
steps:
56+
# Setup
57+
- uses: actions/checkout@v3
58+
with:
59+
fetch-depth: 0
60+
- uses: dtolnay/rust-toolchain@stable
61+
- uses: swatinem/rust-cache@v2
62+
63+
# If you use any mdbook plugins, here's the place to install them!
64+
65+
# Install and run oranda (and mdbook)!
66+
#
67+
# This will write all output to ./public/ (including copying mdbook's output to there).
68+
- name: Install and run oranda
69+
run: |
70+
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/oranda/releases/download/v0.6.1/oranda-installer.sh | sh
71+
oranda build
72+
73+
# Deploy to our gh-pages branch (creating it if it doesn't exist).
74+
# The "public" dir that oranda made above will become the root dir
75+
# of this branch.
76+
#
77+
# Note that once the gh-pages branch exists, you must
78+
# go into repo's settings > pages and set "deploy from branch: gh-pages".
79+
# The other defaults work fine.
80+
- name: Deploy to Github Pages
81+
uses: JamesIves/[email protected]
82+
# ONLY if we're on main (so no PRs or feature branches allowed!)
83+
if: ${{ github.ref == 'refs/heads/main' }}
84+
with:
85+
branch: gh-pages
86+
# Gotta tell the action where to find oranda's output
87+
folder: public
88+
token: ${{ secrets.GITHUB_TOKEN }}
89+
single-commit: true

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/target
2+
3+
# Generated by `oranda generate ci`
4+
public/

0 commit comments

Comments
 (0)