chore: update and fix cargo-dist config.

.github/workflows/release.yml

@@ -1,140 +1,268 @@
+# Copyright 2022-2024, 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 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 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 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 Github Release™ for each one.
+# 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 Github Release™
+# 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]+*'
+ - '**[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:
- 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
- - name: Install Rust
- run: rustup update 1.67.1 --no-self-update && rustup default 1.67.1
+ - 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.0.7/cargo-dist-installer.sh | sh
- - id: create-release
+ # 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.13.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 plan --tag=${{ github.ref_name }} --output-format=json > dist-manifest.json
- echo "dist plan ran successfully"
- cat dist-manifest.json
+ cargo dist ${{ (!github.event.pull_request && format('host --steps=create --tag={0}', github.ref_name)) || 'plan' }} --output-format=json > plan-dist-manifest.json
+ echo "cargo 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
 
- # 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!"
+ # 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 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
+ with:
+ key: ${{ join(matrix.targets, '-') }}
+ - name: Install cargo-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
+ 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 ".upload_files[]" dist-manifest.json >> "$GITHUB_OUTPUT"
+ echo "EOF" >> "$GITHUB_OUTPUT"
 
- # Upload the manifest to the Github Release™
- gh release upload ${{ github.ref_name }} dist-manifest.json
- echo "uploaded manifest!"
+ 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 }}
 
- # 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 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 cargo-dist
+ shell: bash
+ run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.13.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@v4
+ with:
+ pattern: artifacts-*
+ path: target/distrib/
+ merge-multiple: true
+ - 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"
 
- # Build and packages all the things
- upload-artifacts:
- # Let the initial task tell us to not run (currently very blunt)
- needs: create-release
- if: ${{ needs.create-release.outputs.has-releases == 'true' }}
- 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
+ # 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"
 
- runs-on: ${{ matrix.os }}
+ 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@v3
- - name: Install Rust
- run: rustup update 1.67.1 --no-self-update && rustup default 1.67.1
+ - uses: actions/checkout@v4
+  with:
+  submodules: recursive
  - 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: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.13.1/cargo-dist-installer.sh | sh"
+ # Fetch artifacts from scratch-storage
+ - name: Fetch artifacts
+ uses: actions/download-artifact@v4
+ with:
+ pattern: artifacts-*
+ path: target/distrib/
+ merge-multiple: true
+ # This is a harmless no-op for GitHub Releases, hosting for that happens in "announce"
+ - id: host
+ 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"
+ 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@v4
+ with:
+ # Overwrite the previous copy
+ name: artifacts-dist-manifest
+ path: dist-manifest.json
 
- # 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!"
-
- # Mark the Github Release™ as a non-draft now that everything has succeeded!
- 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') }}
- runs-on: ubuntu-latest
+ # 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@v3
- - name: mark release as non-draft
+ - uses: actions/checkout@v4
+ with:
+ submodules: recursive
+ - name: "Download GitHub Artifacts"
+ uses: actions/download-artifact@v4
+ with:
+ pattern: artifacts-*
+ path: artifacts
+ merge-multiple: true
+ - name: Cleanup
  run: |
- gh release edit ${{ github.ref_name }} --draft=false
+ # 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/*"

Cargo.toml

@@ -19,8 +19,15 @@ lto = "thin"
 
 # Config for 'cargo dist'
 [workspace.metadata.dist]
-cargo-dist-version = "0.0.7"
-rust-toolchain-version = "1.67.1"
+# The preferred cargo-dist version to use in CI (Cargo.toml SemVer syntax)
+cargo-dist-version = "0.13.1"
+# CI backends to support
 ci = ["github"]
+# The installers to generate for each app
 installers = ["shell", "powershell"]
-targets = ["x86_64-unknown-linux-gnu", "x86_64-apple-darwin", "x86_64-pc-windows-msvc", "aarch64-apple-darwin"]
+# 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"]
+# Publish jobs to run in CI
+pr-run-mode = "plan"
+# Whether to install an updater program
+install-updater = false

moz-webgpu-cts/Cargo.toml

@@ -7,6 +7,9 @@ repository = "https://github.com/ErichDonGubler/moz-webgpu-cts"
 license = "MIT or Apache-2.0"
 publish = false
 
+[package.metadata.dist]
+dist = true
+
 [dependencies]
 camino = "1.1.6"
 clap = { version = "4.4.2", features = ["derive"] }