Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(dist): bump cargo dist and add homebrew and msi artifacts
- Loading branch information
Showing
3 changed files
with
369 additions
and
97 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,140 +1,196 @@ | ||
| # Copyright 2022-2023, axodotdev | ||
| # SPDX-License-Identifier: MIT or Apache-2.0 | ||
| # | ||
| # CI that: | ||
| # | ||
| # * checks for a Git Tag that looks like a release | ||
| # * creates a Github Release™ and fills in its text | ||
| # * builds artifacts with cargo-dist (executable-zips, installers) | ||
| # * uploads those artifacts to the Github 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 artifacts, | ||
| # so there will be a few minutes where the release has no artifacts | ||
| # 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 | ||
| # like "v1", "v1.2.0", "v0.1.0-prerelease01", "my-app-v1.0.0", etc. | ||
| # The version will be roughly parsed as ({PACKAGE_NAME}-)?v{VERSION}, where | ||
| # 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 be a Cargo-style SemVer Version (must have at least major.minor.patch). | ||
| # | ||
| # If PACKAGE_NAME is specified, then we will create a Github Release™ for that | ||
| # If PACKAGE_NAME is specified, then the release 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 we will create a Github Release™ for all | ||
| # (cargo-dist-able) packages in the workspace with that version (this is mode is | ||
| # If PACKAGE_NAME isn't specified, then the release 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 Github Release™ for each one. | ||
| # spin up, creating an independent Github Release™ 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 Github Release™ | ||
| # If there's a prerelease-style suffix to the version, then the Github Release™ | ||
| # will be marked as a prerelease. | ||
| on: | ||
| push: | ||
| tags: | ||
| - '*-?v[0-9]+*' | ||
| - '**[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' to determine what tasks we need to do | ||
| plan: | ||
| runs-on: ubuntu-latest | ||
| outputs: | ||
| has-releases: ${{ steps.create-release.outputs.has-releases }} | ||
| 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 | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| submodules: recursive | ||
| - name: Install Rust | ||
| run: rustup update 1.67.1 --no-self-update && rustup default 1.67.1 | ||
| run: rustup update "1.67.1" --no-self-update && rustup default "1.67.1" | ||
| - name: Install cargo-dist | ||
| run: curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.0.7/cargo-dist-installer.sh | sh | ||
| - id: create-release | ||
| run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.3.0/cargo-dist-installer.sh | sh" | ||
| - id: plan | ||
| run: | | ||
| cargo dist plan --tag=${{ github.ref_name }} --output-format=json > dist-manifest.json | ||
| echo "dist plan ran successfully" | ||
| cargo dist plan ${{ !github.event.pull_request && format('--tag={0}', github.ref_name) || '' }} --output-format=json > dist-manifest.json | ||
| echo "cargo dist plan 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 | ||
|
|
||
| # Create the Github Release™ based on what cargo-dist thinks it should be | ||
| ANNOUNCEMENT_TITLE=$(jq --raw-output ".announcement_title" dist-manifest.json) | ||
| IS_PRERELEASE=$(jq --raw-output ".announcement_is_prerelease" dist-manifest.json) | ||
| jq --raw-output ".announcement_github_body" dist-manifest.json > new_dist_announcement.md | ||
| gh release create ${{ github.ref_name }} --draft --prerelease="$IS_PRERELEASE" --title="$ANNOUNCEMENT_TITLE" --notes-file=new_dist_announcement.md | ||
| echo "created announcement!" | ||
| # Upload the manifest to the Github Release™ | ||
| gh release upload ${{ github.ref_name }} dist-manifest.json | ||
| echo "uploaded manifest!" | ||
| # Disable all the upload-artifacts tasks if we have no actual releases | ||
| HAS_RELEASES=$(jq --raw-output ".releases != null" dist-manifest.json) | ||
| echo "has-releases=$HAS_RELEASES" >> "$GITHUB_OUTPUT" | ||
| # Build and packages all the things | ||
| upload-artifacts: | ||
| # Build and packages all the platform-specific things | ||
| upload-local-artifacts: | ||
| # Let the initial task tell us to not run (currently very blunt) | ||
| needs: create-release | ||
| if: ${{ needs.create-release.outputs.has-releases == 'true' }} | ||
| needs: plan | ||
| if: ${{ fromJson(needs.plan.outputs.val).releases != null && (needs.plan.outputs.publishing == 'true' || fromJson(needs.plan.outputs.val).ci.github.pr_run_mode == 'upload') }} | ||
| strategy: | ||
| matrix: | ||
| # For these target platforms | ||
| include: | ||
| - os: ubuntu-20.04 | ||
| dist-args: --artifacts=global | ||
| install-dist: curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.0.7/cargo-dist-installer.sh | sh | ||
| - os: macos-11 | ||
| dist-args: --artifacts=local --target=aarch64-apple-darwin --target=x86_64-apple-darwin | ||
| install-dist: curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.0.7/cargo-dist-installer.sh | sh | ||
| - os: ubuntu-20.04 | ||
| dist-args: --artifacts=local --target=x86_64-unknown-linux-gnu | ||
| install-dist: curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.0.7/cargo-dist-installer.sh | sh | ||
| - os: windows-2019 | ||
| dist-args: --artifacts=local --target=x86_64-pc-windows-msvc | ||
| install-dist: irm https://github.com/axodotdev/cargo-dist/releases/download/v0.0.7/cargo-dist-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 }} | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| submodules: recursive | ||
| - name: Install Rust | ||
| run: rustup update 1.67.1 --no-self-update && rustup default 1.67.1 | ||
| run: rustup update "1.67.1" --no-self-update && rustup default "1.67.1" | ||
| - 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 commands. | ||
| run: ${{ matrix.install_dist }} | ||
| - id: cargo-dist | ||
| # 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. cargo-dist and jq work fine | ||
| # in powershell. | ||
| shell: bash | ||
| run: | | ||
| # Actually do builds and make zips and whatnot | ||
| cargo dist build --tag=${{ github.ref_name }} --output-format=json ${{ matrix.dist-args }} > dist-manifest.json | ||
| echo "dist ran successfully" | ||
| cat dist-manifest.json | ||
| cargo dist build ${{ needs.plan.outputs.tag-flag }} --output-format=json ${{ matrix.dist_args }} > dist-manifest.json | ||
| echo "cargo dist ran successfully" | ||
| # Parse out what we just built and upload it to the Github Release™ | ||
| jq --raw-output ".artifacts[]?.path | select( . != null )" dist-manifest.json > uploads.txt | ||
| echo "uploading..." | ||
| cat uploads.txt | ||
| gh release upload ${{ github.ref_name }} $(cat uploads.txt) | ||
| echo "uploaded!" | ||
| echo "paths<<EOF" >> "$GITHUB_OUTPUT" | ||
| jq --raw-output ".artifacts[]?.path | select( . != null )" dist-manifest.json >> "$GITHUB_OUTPUT" | ||
| echo "EOF" >> "$GITHUB_OUTPUT" | ||
| - name: "Upload artifacts" | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: artifacts | ||
| path: ${{ steps.cargo-dist.outputs.paths }} | ||
|
|
||
| # Mark the Github Release™ as a non-draft now that everything has succeeded! | ||
| # Build and package all the platform-agnostic(ish) things | ||
| upload-global-artifacts: | ||
| needs: [plan, upload-local-artifacts] | ||
| runs-on: "ubuntu-20.04" | ||
| env: | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| submodules: recursive | ||
| - name: Install Rust | ||
| run: rustup update "1.67.1" --no-self-update && rustup default "1.67.1" | ||
| - name: Install cargo-dist | ||
| run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.3.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 the Github Release™ | ||
| echo "paths<<EOF" >> "$GITHUB_OUTPUT" | ||
| jq --raw-output ".artifacts[]?.path | select( . != null )" dist-manifest.json >> "$GITHUB_OUTPUT" | ||
| echo "EOF" >> "$GITHUB_OUTPUT" | ||
| - name: "Upload artifacts" | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: artifacts | ||
| path: ${{ steps.cargo-dist.outputs.paths }} | ||
|
|
||
| should-publish: | ||
| needs: | ||
| - plan | ||
| - upload-local-artifacts | ||
| - upload-global-artifacts | ||
| if: ${{ needs.plan.outputs.publishing == 'true' }} | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: print tag | ||
| run: echo "ok we're publishing!" | ||
|
|
||
| # Create a Github Release with all the results once everything is done, | ||
| publish-release: | ||
| # Only run after all the other tasks, but it's ok if upload-artifacts was skipped | ||
| needs: [create-release, upload-artifacts] | ||
| if: ${{ always() && needs.create-release.result == 'success' && (needs.upload-artifacts.result == 'skipped' || needs.upload-artifacts.result == 'success') }} | ||
| needs: [plan, should-publish] | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - name: mark release as non-draft | ||
| run: | | ||
| gh release edit ${{ github.ref_name }} --draft=false | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| submodules: recursive | ||
| - name: "Download artifacts" | ||
| uses: actions/download-artifact@v3 | ||
| with: | ||
| name: artifacts | ||
| path: artifacts | ||
| - name: Create Release | ||
| uses: ncipollo/release-action@v1 | ||
| with: | ||
| tag: ${{ needs.plan.outputs.tag }} | ||
| name: ${{ fromJson(needs.plan.outputs.val).announcement_title }} | ||
| body: ${{ fromJson(needs.plan.outputs.val).announcement_github_body }} | ||
| prerelease: ${{ fromJson(needs.plan.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.