-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
464 additions
and
100 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,136 +1,260 @@ | ||
| # Copyright 2022-2023, axodotdev | ||
| # SPDX-License-Identifier: MIT or Apache-2.0 | ||
| # | ||
| # CI that: | ||
| # | ||
| # * checks for a Git Tag that looks like a release ("v1.2.0") | ||
| # * creates a Github Release™️ | ||
| # * builds binaries/packages with cargo-dist | ||
| # * uploads those packages to the Github Release™️ | ||
| # * checks for a Git Tag that looks like a release | ||
| # * builds artifacts with cargo-dist (archives, installers, hashes) | ||
| # * uploads those artifacts to temporary workflow zip | ||
| # * on success, uploads the artifacts to a Github Release | ||
| # | ||
| # Note that the Github Release™️ will be created before the packages, | ||
| # so there will be a few minutes where the release has no packages | ||
| # and then they will slowly trickle in, possibly failing. To make | ||
| # this more pleasant we mark the release as a "draft" until all | ||
| # artifacts have been successfully uploaded. This allows you to | ||
| # choose what to do with partial successes and avoids spamming | ||
| # anyone with notifications before the release is actually ready. | ||
| # Note that the Github Release will be created with a generated | ||
| # title/body based on your changelogs. | ||
|
|
||
| name: Release | ||
|
|
||
| permissions: | ||
| contents: write | ||
|
|
||
| # This task will run whenever you push a git tag that looks like | ||
| # a version number. We just look for `v` followed by at least one number | ||
| # and then whatever. so `v1`, `v1.0.0`, and `v1.0.0-prerelease` all work. | ||
| # This task will run whenever you push a git tag that looks like a version | ||
| # like "1.0.0", "v0.1.0-prerelease.1", "my-app/0.1.0", "releases/v1.0.0", etc. | ||
| # Various formats will be parsed into a VERSION and an optional PACKAGE_NAME, where | ||
| # PACKAGE_NAME must be the name of a Cargo package in your workspace, and VERSION | ||
| # must be a Cargo-style SemVer Version (must have at least major.minor.patch). | ||
| # | ||
| # If PACKAGE_NAME is specified, then the announcement will be for that | ||
| # package (erroring out if it doesn't have the given version or isn't cargo-dist-able). | ||
| # | ||
| # If there's a prerelease-style suffix to the version then the Github Release™️ | ||
| # will be marked as a prerelease (handled by taiki-e/create-gh-release-action). | ||
| # If PACKAGE_NAME isn't specified, then the announcement will be for all | ||
| # (cargo-dist-able) packages in the workspace with that version (this mode is | ||
| # intended for workspaces with only one dist-able package, or with all dist-able | ||
| # packages versioned/released in lockstep). | ||
| # | ||
| # Note that when generating links to uploaded artifacts, cargo-dist will currently | ||
| # assume that your git tag is always v{VERSION} where VERSION is the version in | ||
| # the published package's Cargo.toml (this is the default behaviour of cargo-release). | ||
| # In the future this may be made more robust/configurable. | ||
| # If you push multiple tags at once, separate instances of this workflow will | ||
| # spin up, creating an independent announcement for each one. However Github | ||
| # will hard limit this to 3 tags per commit, as it will assume more tags is a | ||
| # mistake. | ||
| # | ||
| # If there's a prerelease-style suffix to the version, then the release(s) | ||
| # will be marked as a prerelease. | ||
| on: | ||
| push: | ||
| tags: | ||
| - v[0-9]+.* | ||
|
|
||
| env: | ||
| ALL_CARGO_DIST_TARGET_ARGS: --target=x86_64-unknown-linux-gnu --target=x86_64-apple-darwin --target=x86_64-pc-windows-msvc | ||
| ALL_CARGO_DIST_INSTALLER_ARGS: | ||
| - '**[0-9]+.[0-9]+.[0-9]+*' | ||
| pull_request: | ||
|
|
||
| jobs: | ||
| # Create the Github Release™️ so the packages have something to be uploaded to | ||
| create-release: | ||
| # Run 'cargo dist plan' (or host) to determine what tasks we need to do | ||
| plan: | ||
| runs-on: ubuntu-latest | ||
| outputs: | ||
| tag: ${{ steps.create-gh-release.outputs.computed-prefix }}${{ steps.create-gh-release.outputs.version }} | ||
| val: ${{ steps.plan.outputs.manifest }} | ||
| tag: ${{ !github.event.pull_request && github.ref_name || '' }} | ||
| tag-flag: ${{ !github.event.pull_request && format('--tag={0}', github.ref_name) || '' }} | ||
| publishing: ${{ !github.event.pull_request }} | ||
| env: | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - id: create-gh-release | ||
| uses: taiki-e/create-gh-release-action@v1 | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| draft: true | ||
| # (required) GitHub token for creating GitHub Releases. | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| submodules: recursive | ||
| - name: Install cargo-dist | ||
| # we specify bash to get pipefail; it guards against the `curl` command | ||
| # failing. otherwise `sh` won't catch that `curl` returned non-0 | ||
| shell: bash | ||
| run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.7.1/cargo-dist-installer.sh | sh" | ||
| # sure would be cool if github gave us proper conditionals... | ||
| # so here's a doubly-nested ternary-via-truthiness to try to provide the best possible | ||
| # functionality based on whether this is a pull_request, and whether it's from a fork. | ||
| # (PRs run on the *source* but secrets are usually on the *target* -- that's *good* | ||
| # but also really annoying to build CI around when it needs secrets to work right.) | ||
| - id: plan | ||
| run: | | ||
| cargo dist ${{ !github.event.pull_request && format('host --steps=create --tag={0}', github.ref_name) || (github.event.pull_request.head.repo.fork && 'plan' || 'host --steps=check') }} --output-format=json > dist-manifest.json | ||
| echo "cargo dist ran successfully" | ||
| cat dist-manifest.json | ||
| echo "manifest=$(jq -c "." dist-manifest.json)" >> "$GITHUB_OUTPUT" | ||
| - name: "Upload dist-manifest.json" | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: artifacts | ||
| path: dist-manifest.json | ||
|
|
||
| # Build and packages all the things | ||
| upload-artifacts: | ||
| needs: create-release | ||
| # Build and packages all the platform-specific things | ||
| build-local-artifacts: | ||
| name: build-local-artifacts (${{ join(matrix.targets, ', ') }}) | ||
| # Let the initial task tell us to not run (currently very blunt) | ||
| needs: | ||
| - plan | ||
| 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') }} | ||
| strategy: | ||
| matrix: | ||
| # For these target platforms | ||
| include: | ||
| - target: x86_64-unknown-linux-gnu | ||
| os: ubuntu-20.04 | ||
| install-dist: curl --proto '=https' --tlsv1.2 -L -sSf https://github.com/axodotdev/cargo-dist/releases/download/v0.0.2/installer.sh | sh | ||
| - target: x86_64-apple-darwin | ||
| os: macos-11 | ||
| install-dist: curl --proto '=https' --tlsv1.2 -L -sSf https://github.com/axodotdev/cargo-dist/releases/download/v0.0.2/installer.sh | sh | ||
| - target: x86_64-pc-windows-msvc | ||
| os: windows-2019 | ||
| install-dist: irm 'https://github.com/axodotdev/cargo-dist/releases/download/v0.0.2/installer.ps1' | iex | ||
| runs-on: ${{ matrix.os }} | ||
| fail-fast: false | ||
| # Target platforms/runners are computed by cargo-dist in create-release. | ||
| # Each member of the matrix has the following arguments: | ||
| # | ||
| # - runner: the github runner | ||
| # - dist-args: cli flags to pass to cargo dist | ||
| # - install-dist: expression to run to install cargo-dist on the runner | ||
| # | ||
| # Typically there will be: | ||
| # - 1 "global" task that builds universal installers | ||
| # - N "local" tasks that build each platform's binaries and platform-specific installers | ||
| matrix: ${{ fromJson(needs.plan.outputs.val).ci.github.artifacts_matrix }} | ||
| runs-on: ${{ matrix.runner }} | ||
| env: | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| BUILD_MANIFEST_NAME: target/distrib/${{ join(matrix.targets, '-') }}-dist-manifest.json | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - name: Install Rust | ||
| run: rustup update stable && rustup default stable | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| submodules: recursive | ||
| - uses: swatinem/rust-cache@v2 | ||
| - name: Install cargo-dist | ||
| run: ${{ matrix.install-dist }} | ||
| - name: Run cargo-dist | ||
| # This logic is a bit janky because it's trying to be a polyglot between | ||
| # powershell and bash since this will run on windows, macos, and linux! | ||
| # The two platforms don't agree on how to talk about env vars but they | ||
| # do agree on 'cat' and '$()' so we use that to marshal values between commmands. | ||
| run: ${{ matrix.install_dist }} | ||
| # Get the dist-manifest | ||
| - name: Fetch local artifacts | ||
| uses: actions/download-artifact@v3 | ||
| with: | ||
| name: artifacts | ||
| path: target/distrib/ | ||
| - name: Install dependencies | ||
| run: | | ||
| ${{ matrix.packages_install }} | ||
| - name: Build artifacts | ||
| run: | | ||
| # Actually do builds and make zips and whatnot | ||
| cargo dist --target=${{ matrix.target }} --output-format=json > dist-manifest.json | ||
| echo "dist ran successfully" | ||
| cat dist-manifest.json | ||
| # Parse out what we just built and upload it to the Github Release™️ | ||
| cat dist-manifest.json | jq --raw-output ".releases[].artifacts[].path" > uploads.txt | ||
| echo "uploading..." | ||
| cat uploads.txt | ||
| gh release upload ${{ needs.create-release.outputs.tag }} $(cat uploads.txt) | ||
| echo "uploaded!" | ||
| cargo dist build ${{ needs.plan.outputs.tag-flag }} --print=linkage --output-format=json ${{ matrix.dist_args }} > dist-manifest.json | ||
| echo "cargo dist ran successfully" | ||
| - id: cargo-dist | ||
| name: Post-build | ||
| # We force bash here just because github makes it really hard to get values up | ||
| # to "real" actions without writing to env-vars, and writing to env-vars has | ||
| # inconsistent syntax between shell and powershell. | ||
| shell: bash | ||
| run: | | ||
| # Parse out what we just built and upload it to scratch storage | ||
| echo "paths<<EOF" >> "$GITHUB_OUTPUT" | ||
| jq --raw-output ".artifacts[]?.path | select( . != null )" dist-manifest.json >> "$GITHUB_OUTPUT" | ||
| echo "EOF" >> "$GITHUB_OUTPUT" | ||
| # Compute and upload the manifest for everything | ||
| upload-manifest: | ||
| needs: create-release | ||
| runs-on: ubuntu-latest | ||
| cp dist-manifest.json "$BUILD_MANIFEST_NAME" | ||
| - name: "Upload artifacts" | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: artifacts | ||
| path: | | ||
| ${{ steps.cargo-dist.outputs.paths }} | ||
| ${{ env.BUILD_MANIFEST_NAME }} | ||
| # Build and package all the platform-agnostic(ish) things | ||
| build-global-artifacts: | ||
| needs: | ||
| - plan | ||
| - build-local-artifacts | ||
| runs-on: "ubuntu-20.04" | ||
| env: | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| BUILD_MANIFEST_NAME: target/distrib/global-dist-manifest.json | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - name: Install Rust | ||
| run: rustup update stable && rustup default stable | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| submodules: recursive | ||
| - name: Install cargo-dist | ||
| run: curl --proto '=https' --tlsv1.2 -L -sSf https://github.com/axodotdev/cargo-dist/releases/download/v0.0.2/installer.sh | sh | ||
| - name: Run cargo-dist manifest | ||
| run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.7.1/cargo-dist-installer.sh | sh" | ||
| # Get all the local artifacts for the global tasks to use (for e.g. checksums) | ||
| - name: Fetch local artifacts | ||
| uses: actions/download-artifact@v3 | ||
| with: | ||
| name: artifacts | ||
| path: target/distrib/ | ||
| - id: cargo-dist | ||
| shell: bash | ||
| run: | | ||
| # Generate a manifest describing everything | ||
| cargo dist manifest --no-local-paths --output-format=json $ALL_CARGO_DIST_TARGET_ARGS $ALL_CARGO_DIST_INSTALLER_ARGS > dist-manifest.json | ||
| echo "dist manifest ran successfully" | ||
| cat dist-manifest.json | ||
| # Upload the manifest to the Github Release™️ | ||
| gh release upload ${{ needs.create-release.outputs.tag }} dist-manifest.json | ||
| echo "uploaded manifest!" | ||
| # Edit the Github Release™️ title/body to match what cargo-dist thinks it should be | ||
| CHANGELOG_TITLE=$(cat dist-manifest.json | jq --raw-output ".releases[].changelog_title") | ||
| cat dist-manifest.json | jq --raw-output ".releases[].changelog_body" > new_dist_changelog.md | ||
| gh release edit ${{ needs.create-release.outputs.tag }} --title="$CHANGELOG_TITLE" --notes-file=new_dist_changelog.md | ||
| echo "updated release notes!" | ||
| cargo dist build ${{ needs.plan.outputs.tag-flag }} --output-format=json "--artifacts=global" > dist-manifest.json | ||
| echo "cargo dist ran successfully" | ||
| # Mark the Github Release™️ as a non-draft now that everything has succeeded! | ||
| publish-release: | ||
| needs: [create-release, upload-artifacts, upload-manifest] | ||
| runs-on: ubuntu-latest | ||
| # Parse out what we just built and upload it to scratch storage | ||
| echo "paths<<EOF" >> "$GITHUB_OUTPUT" | ||
| jq --raw-output ".artifacts[]?.path | select( . != null )" dist-manifest.json >> "$GITHUB_OUTPUT" | ||
| echo "EOF" >> "$GITHUB_OUTPUT" | ||
| cp dist-manifest.json "$BUILD_MANIFEST_NAME" | ||
| - name: "Upload artifacts" | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: artifacts | ||
| path: | | ||
| ${{ steps.cargo-dist.outputs.paths }} | ||
| ${{ env.BUILD_MANIFEST_NAME }} | ||
| # Determines if we should publish/announce | ||
| host: | ||
| needs: | ||
| - plan | ||
| - build-local-artifacts | ||
| - build-global-artifacts | ||
| # Only run if we're "publishing", and only if local and global didn't fail (skipped is fine) | ||
| 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') }} | ||
| env: | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| runs-on: "ubuntu-20.04" | ||
| outputs: | ||
| val: ${{ steps.host.outputs.manifest }} | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - name: mark release as non-draft | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| submodules: recursive | ||
| - name: Install cargo-dist | ||
| run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.7.1/cargo-dist-installer.sh | sh" | ||
| # Fetch artifacts from scratch-storage | ||
| - name: Fetch artifacts | ||
| uses: actions/download-artifact@v3 | ||
| with: | ||
| name: artifacts | ||
| path: target/distrib/ | ||
| # This is a harmless no-op for Github Releases, hosting for that happens in "announce" | ||
| - id: host | ||
| shell: bash | ||
| run: | | ||
| gh release edit ${{ needs.create-release.outputs.tag }} --draft=false | ||
| cargo dist host ${{ needs.plan.outputs.tag-flag }} --steps=upload --steps=release --output-format=json > dist-manifest.json | ||
| echo "artifacts uploaded and released successfully" | ||
| cat dist-manifest.json | ||
| echo "manifest=$(jq -c "." dist-manifest.json)" >> "$GITHUB_OUTPUT" | ||
| - name: "Upload dist-manifest.json" | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: artifacts | ||
| path: dist-manifest.json | ||
|
|
||
| # Create a Github Release while uploading all files to it | ||
| announce: | ||
| needs: | ||
| - plan | ||
| - host | ||
| # use "always() && ..." to allow us to wait for all publish jobs while | ||
| # still allowing individual publish jobs to skip themselves (for prereleases). | ||
| # "host" however must run to completion, no skipping allowed! | ||
| if: ${{ always() && needs.host.result == 'success' }} | ||
| runs-on: "ubuntu-20.04" | ||
| env: | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| submodules: recursive | ||
| - name: "Download Github Artifacts" | ||
| uses: actions/download-artifact@v3 | ||
| with: | ||
| name: artifacts | ||
| path: artifacts | ||
| - name: Cleanup | ||
| run: | | ||
| # Remove the granular manifests | ||
| rm -f artifacts/*-dist-manifest.json | ||
| - name: Create Github Release | ||
| uses: ncipollo/release-action@v1 | ||
| with: | ||
| tag: ${{ needs.plan.outputs.tag }} | ||
| name: ${{ fromJson(needs.host.outputs.val).announcement_title }} | ||
| body: ${{ fromJson(needs.host.outputs.val).announcement_github_body }} | ||
| prerelease: ${{ fromJson(needs.host.outputs.val).announcement_is_prerelease }} | ||
| artifacts: "artifacts/*" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.