Add dist configuration for generating air binaries
#67
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,282 @@ | ||
| # This file was autogenerated by dist: https://opensource.axo.dev/cargo-dist/ | ||
| # | ||
| # Copyright 2022-2024, axodotdev | ||
| # SPDX-License-Identifier: MIT or Apache-2.0 | ||
| # | ||
| # CI that: | ||
| # | ||
| # * checks for a Git Tag that looks like a release | ||
| # * builds artifacts with 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 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 "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 dist-able). | ||
| # | ||
| # If PACKAGE_NAME isn't specified, then the announcement will be for all | ||
| # (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]+*' | ||
|
|
||
| jobs: | ||
| # Run 'dist plan' (or host) to determine what tasks we need to do | ||
| plan: | ||
| runs-on: "ubuntu-20.04" | ||
| 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 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.25.1/cargo-dist-installer.sh | sh" | ||
| - name: Cache dist | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: cargo-dist-cache | ||
| path: ~/.cargo/bin/dist | ||
| # 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: | | ||
| dist ${{ (!github.event.pull_request && format('host --steps=create --tag={0}', github.ref_name)) || 'plan' }} --output-format=json > plan-dist-manifest.json | ||
| echo "dist ran successfully" | ||
| cat plan-dist-manifest.json | ||
| echo "manifest=$(jq -c "." plan-dist-manifest.json)" >> "$GITHUB_OUTPUT" | ||
| - name: "Upload dist-manifest.json" | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: artifacts-plan-dist-manifest | ||
| path: plan-dist-manifest.json | ||
|
|
||
| # 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: | ||
| fail-fast: false | ||
| # Target platforms/runners are computed by dist in create-release. | ||
| # Each member of the matrix has the following arguments: | ||
| # | ||
| # - runner: the github runner | ||
| # - dist-args: cli flags to pass to dist | ||
| # - install-dist: expression to run to install 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: | ||
| - name: enable windows longpaths | ||
| run: | | ||
| git config --global core.longpaths true | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| submodules: recursive | ||
| - name: Install dist | ||
| run: ${{ matrix.install_dist }} | ||
| # Get the dist-manifest | ||
| - name: Fetch local artifacts | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| pattern: artifacts-* | ||
| path: target/distrib/ | ||
| merge-multiple: true | ||
| - name: Install dependencies | ||
| run: | | ||
| ${{ matrix.packages_install }} | ||
| - name: Build artifacts | ||
| run: | | ||
| # Actually do builds and make zips and whatnot | ||
| dist build ${{ needs.plan.outputs.tag-flag }} --print=linkage --output-format=json ${{ matrix.dist_args }} > dist-manifest.json | ||
| echo "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 ".upload_files[]" dist-manifest.json >> "$GITHUB_OUTPUT" | ||
| echo "EOF" >> "$GITHUB_OUTPUT" | ||
|
|
||
| cp dist-manifest.json "$BUILD_MANIFEST_NAME" | ||
| - name: "Upload artifacts" | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: artifacts-build-local-${{ join(matrix.targets, '_') }} | ||
| 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@v4 | ||
| with: | ||
| submodules: recursive | ||
| - name: Install cached dist | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: cargo-dist-cache | ||
| path: ~/.cargo/bin/ | ||
| - run: chmod +x ~/.cargo/bin/dist | ||
| # Get all the local artifacts for the global tasks to use (for e.g. checksums) | ||
| - name: Fetch local artifacts | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| pattern: artifacts-* | ||
| path: target/distrib/ | ||
| merge-multiple: true | ||
| - id: cargo-dist | ||
| shell: bash | ||
| run: | | ||
| dist build ${{ needs.plan.outputs.tag-flag }} --output-format=json "--artifacts=global" > dist-manifest.json | ||
| echo "dist ran successfully" | ||
|
|
||
| # Parse out what we just built and upload it to scratch storage | ||
| echo "paths<<EOF" >> "$GITHUB_OUTPUT" | ||
| jq --raw-output ".upload_files[]" dist-manifest.json >> "$GITHUB_OUTPUT" | ||
| echo "EOF" >> "$GITHUB_OUTPUT" | ||
|
|
||
| cp dist-manifest.json "$BUILD_MANIFEST_NAME" | ||
| - name: "Upload artifacts" | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: artifacts-build-global | ||
| 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@v4 | ||
| with: | ||
| submodules: recursive | ||
| - name: Install cached dist | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: cargo-dist-cache | ||
| path: ~/.cargo/bin/ | ||
| - run: chmod +x ~/.cargo/bin/dist | ||
| # Fetch artifacts from scratch-storage | ||
| - name: Fetch artifacts | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| pattern: artifacts-* | ||
| path: target/distrib/ | ||
| merge-multiple: true | ||
| - id: host | ||
| shell: bash | ||
| run: | | ||
| 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@v4 | ||
| with: | ||
| # Overwrite the previous copy | ||
| name: artifacts-dist-manifest | ||
| path: dist-manifest.json | ||
| # Create a GitHub Release while uploading all files to it | ||
| - name: "Download GitHub Artifacts" | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| pattern: artifacts-* | ||
| path: artifacts | ||
| merge-multiple: true | ||
| - name: Cleanup | ||
| run: | | ||
| # Remove the granular manifests | ||
| rm -f artifacts/*-dist-manifest.json | ||
| - name: Create GitHub Release | ||
| env: | ||
| PRERELEASE_FLAG: "${{ fromJson(steps.host.outputs.manifest).announcement_is_prerelease && '--prerelease' || '' }}" | ||
| ANNOUNCEMENT_TITLE: "${{ fromJson(steps.host.outputs.manifest).announcement_title }}" | ||
| ANNOUNCEMENT_BODY: "${{ fromJson(steps.host.outputs.manifest).announcement_github_body }}" | ||
| RELEASE_COMMIT: "${{ github.sha }}" | ||
| run: | | ||
| # Write and read notes from a file to avoid quoting breaking things | ||
| echo "$ANNOUNCEMENT_BODY" > $RUNNER_TEMP/notes.txt | ||
|
|
||
| gh release create "${{ needs.plan.outputs.tag }}" --target "$RELEASE_COMMIT" $PRERELEASE_FLAG --title "$ANNOUNCEMENT_TITLE" --notes-file "$RUNNER_TEMP/notes.txt" artifacts/* | ||
|
|
||
| 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 | ||
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
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
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,27 @@ | ||
| [workspace] | ||
| members = ["cargo:."] | ||
|
|
||
| # Config for 'dist' | ||
| [dist] | ||
| # The preferred dist version to use in CI (Cargo.toml SemVer syntax) | ||
| cargo-dist-version = "0.25.1" | ||
| # CI backends to support | ||
| ci = "github" | ||
| # Whether dist should create a Github Release or use an existing draft | ||
| create-release = true | ||
| # The installers to generate for each app | ||
| installers = ["shell", "powershell"] | ||
|
Comment on lines
+12
to
+13
There was a problem hiding this comment. So we get .sh and .ps installer scripts |
||
| # The archive format to use for windows builds (defaults .zip) | ||
| windows-archive = ".zip" | ||
| # The archive format to use for non-windows builds (defaults .tar.xz) | ||
| unix-archive = ".tar.gz" | ||
| # Target platforms to build apps for (Rust target-triple syntax) | ||
| targets = ["aarch64-apple-darwin", "x86_64-apple-darwin", "x86_64-unknown-linux-gnu", "x86_64-pc-windows-msvc"] | ||
|
Comment on lines
+18
to
+19
There was a problem hiding this comment. |
||
| # Whether to auto-include files like READMEs, LICENSEs, and CHANGELOGs (default true) | ||
| auto-includes = false | ||
| # Which actions to run on pull requests (use "upload" to force a build in CI for testing) | ||
| pr-run-mode = "skip" | ||
| # Path that installers should place binaries in | ||
| install-path = ["$XDG_BIN_HOME/", "$XDG_DATA_HOME/../bin", "~/.local/bin"] | ||
|
Comment on lines
+24
to
+25
There was a problem hiding this comment. This is us mimicking ruff astral-sh/ruff#14457 (this is also a new thing for them, they are trying this out) Oddly the default install path (used by the shell and powershell installers) is There was a problem hiding this comment.
There was a problem hiding this comment. It looks like on maOS this will use On macOS I would expect it to go in There was a problem hiding this comment. We did a little research and On Window you'll get a message telling you to "restart your system" You really do need to restart your computer (or the The install script tweaks the Note that updating the Path here is nice, it means that both This is also just a 1 time restart that is required. Next time the user updates (or if theyve installed ruff before air), the Path will already be up to date, so it should just work without a restart. On macOS, it's basically the same as above but you only need to restart your shell, not your whole system. The message on mac says |
||
| # Whether to install an updater program | ||
| install-updater = false | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note how they create a gh release for us using the tag name