Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Build release artifacts with cargo-dist (#96)
cargo-dist[^1] is a new tool that makes it easy to build and package release artifacts for Rust applications. It supports integration with GitHub, where it builds artifacts on GitHub Actions and publishes them to a matching GitHub release. We are somewhat opinionated about our release process, and have tweaked the default configuration for cargo-dist to match our existing process. Releases are still prepared and published using the GitHub UI, and cargo-dist will only handle the building of release artifacts. [^1]: https://github.com/axodotdev/cargo-dist
- Loading branch information
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 |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| name: crates.io | ||
|
|
||
| "on": | ||
| release: | ||
| types: | ||
| - published | ||
|
|
||
| jobs: | ||
| crates: | ||
| name: Publish | ||
| runs-on: ubuntu-latest | ||
|
|
||
| container: | ||
| image: ghcr.io/jdno/rust:main | ||
|
|
||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Cache build artifacts | ||
| uses: swatinem/[email protected] | ||
|
|
||
| - name: Publish to crates.io | ||
| run: cargo publish --token ${{ secrets.CRATES_TOKEN }} -v --all-features |
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,25 +1,266 @@ | ||
| # Copyright 2022-2023, axodotdev | ||
| # SPDX-License-Identifier: MIT or Apache-2.0 | ||
| # | ||
| # CI that: | ||
| # | ||
| # * 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 a Github Release with this tag is assumed to exist as a draft | ||
| # with the appropriate title/body, and will be undrafted for you. | ||
|
|
||
| name: Release | ||
|
|
||
| permissions: | ||
| contents: write | ||
|
|
||
| # 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 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). | ||
| # | ||
| # 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: | ||
| - "**[0-9]+.[0-9]+.[0-9]+*" | ||
| pull_request: | ||
|
|
||
| jobs: | ||
| # Run 'cargo dist plan' (or host) to determine what tasks we need to do | ||
| plan: | ||
| name: Plan | ||
| runs-on: ubuntu-latest | ||
| outputs: | ||
| 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@v4 | ||
| with: | ||
| 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.6.0/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 platform-specific things | ||
| build-local-artifacts: | ||
| name: Build local artifacts | ||
| # 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: | ||
| 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@v4 | ||
| with: | ||
| submodules: recursive | ||
| - uses: swatinem/rust-cache@v2 | ||
| - name: Install cargo-dist | ||
| 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 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" | ||
| 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: | ||
| name: Build global artifacts | ||
| needs: | ||
| - plan | ||
| - build-local-artifacts | ||
| runs-on: "ubuntu-20.04" | ||
| env: | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| BUILD_MANIFEST_NAME: target/distrib/dist-manifest.json | ||
| steps: | ||
| - 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.6.0/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: | | ||
| cargo dist build ${{ needs.plan.outputs.tag-flag }} --output-format=json "--artifacts=global" > dist-manifest.json | ||
| echo "cargo dist ran successfully" | ||
| # 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: | ||
| name: Prepare release | ||
| 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@v4 | ||
| with: | ||
| submodules: recursive | ||
| - name: Install cargo-dist | ||
| run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.6.0/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: | | ||
| 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: | ||
| name: Publish release | ||
| 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 }} | ||
| allowUpdates: true | ||
| updateOnlyUnreleased: true | ||
| omitBodyDuringUpdate: true | ||
| omitNameDuringUpdate: true | ||
| 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