Add a "--help" argument to both binaries using clap #22
Workflow file for this run
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
| # 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 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 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 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. 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™ | |
| # will be marked as a prerelease. | |
| on: | |
| push: | |
| tags: | |
| - '**[0-9]+.[0-9]+.[0-9]+*' | |
| pull_request: | |
| jobs: | |
| # Run 'cargo dist plan' to determine what tasks we need to do | |
| 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 | |
| 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 ${{ !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 | |
| # Build and packages all the platform-specific things | |
| upload-local-artifacts: | |
| # Let the initial task tell us to not run (currently very blunt) | |
| 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: | |
| 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@v4 | |
| with: | |
| submodules: recursive | |
| - uses: swatinem/rust-cache@v2 | |
| - name: Install cargo-dist | |
| 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 ${{ 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™ | |
| 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 }} | |
| # 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 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!" | |
| publish-homebrew-formula: | |
| needs: [plan, should-publish] | |
| runs-on: "ubuntu-20.04" | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| PLAN: ${{ needs.plan.outputs.val }} | |
| GITHUB_USER: "axo bot" | |
| GITHUB_EMAIL: "admin+bot@axo.dev" | |
| if: ${{ !fromJson(needs.plan.outputs.val).announcement_is_prerelease || fromJson(needs.plan.outputs.val).publish_prereleases }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| repository: "andrewdavidmackenzie/pigg-tap" | |
| token: ${{ secrets.HOMEBREW_TAP_TOKEN }} | |
| # So we have access to the formula | |
| - name: Fetch local artifacts | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: artifacts | |
| path: Formula/ | |
| - name: Commit formula files | |
| run: | | |
| git config --global user.name "${GITHUB_USER}" | |
| git config --global user.email "${GITHUB_EMAIL}" | |
| for release in $(echo "$PLAN" | jq --compact-output '.releases[]'); do | |
| name=$(echo "$release" | jq .app_name --raw-output) | |
| version=$(echo "$release" | jq .app_version --raw-output) | |
| git add Formula/${name}.rb | |
| git commit -m "${name} ${version}" | |
| done | |
| git push | |
| # Create a Github Release with all the results once everything is done, | |
| publish-release: | |
| needs: [plan, should-publish] | |
| runs-on: ubuntu-latest | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| steps: | |
| - 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/*" |