Skip to content

Worktrunk is a CLI for Git worktree management, designed for parallel AI agent workflows

Switch to cargo-dist for release automation

Maximilian Roosf6ca019b1c5e
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 6dea9ba54..cd102fd58 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -1,174 +1,314 @@
-# This workflow runs on GitHub releases. It also runs on workflow_call and
-# workflow_dispatch without publishing, to test that builds work correctly.
+# This file was autogenerated by dist: https://axodotdev.github.io/cargo-dist
#
-# Publishing only occurs when github.event_name == 'release'.
+# 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:
- release:
- types: [released] # Only final releases, not drafts
- workflow_call:
- workflow_dispatch:
-
-env:
- CARGO_TERM_COLOR: always
- CLICOLOR_FORCE: 1
- RUSTFLAGS: "-C debuginfo=0"
+ pull_request:
+ push:
+ tags:
+ - '**[0-9]+.[0-9]+.[0-9]+*'
jobs:
- build:
- name: Build ${{ matrix.target }}
- runs-on: ${{ matrix.os }}
+ # Run 'dist plan' (or host) to determine what tasks we need to do
+ plan:
+ runs-on: "ubuntu-22.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:
+ persist-credentials: false
+ 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.30.2/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
- matrix:
- include:
- # macOS ARM (Apple Silicon)
- - os: macos-14
- target: aarch64-apple-darwin
-
- # macOS Intel
- - os: macos-13
- target: x86_64-apple-darwin
-
- # Linux x86_64 (musl for static binary)
- - os: ubuntu-latest
- target: x86_64-unknown-linux-musl
-
- # Linux ARM64 (musl for static binary)
- - os: ubuntu-latest
- target: aarch64-unknown-linux-musl
-
- # Windows x86_64
- - os: windows-latest
- target: x86_64-pc-windows-msvc
-
- permissions:
- contents: write
-
+ # 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 }}
+ container: ${{ matrix.container && matrix.container.image || null }}
+ env:
+ GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ BUILD_MANIFEST_NAME: target/distrib/${{ join(matrix.targets, '-') }}-dist-manifest.json
steps:
- - name: πŸ“‚ Checkout code
- uses: actions/checkout@v5
-
- - name: πŸ¦€ Install Rust
- uses: dtolnay/rust-toolchain@stable
-
- - name: 🎯 Add target
- run: rustup target add ${{ matrix.target }}
-
- - name: Install musl tools (Linux musl only)
- if: contains(matrix.target, 'musl')
+ - name: enable windows longpaths
run: |
- sudo apt-get update
- sudo apt-get install -y musl-tools
- if [ "${{ matrix.target }}" = "aarch64-unknown-linux-musl" ]; then
- sudo apt-get install -y gcc-aarch64-linux-gnu
+ git config --global core.longpaths true
+ - uses: actions/checkout@v4
+ with:
+ persist-credentials: false
+ submodules: recursive
+ - name: Install Rust non-interactively if not already installed
+ if: ${{ matrix.container }}
+ run: |
+ if ! command -v cargo > /dev/null 2>&1; then
+ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+ echo "$HOME/.cargo/bin" >> $GITHUB_PATH
fi
-
- - name: πŸ’° Cache
- uses: Swatinem/rust-cache@v2
+ - name: Install dist
+ run: ${{ matrix.install_dist.run }}
+ # Get the dist-manifest
+ - name: Fetch local artifacts
+ uses: actions/download-artifact@v4
with:
- prefix-key: release-${{ matrix.target }}-${{ hashFiles('Cargo.lock') }}
-
- - name: 🏭 Build release binary
- run: cargo build --release --locked --target ${{ matrix.target }}
- env:
- # For cross-compiling to aarch64-unknown-linux-musl
- CARGO_TARGET_AARCH64_UNKNOWN_LINUX_MUSL_LINKER: aarch64-linux-gnu-gcc
-
- - name: πŸ“¦ Package binary (Unix)
- if: matrix.os != 'windows-latest'
+ pattern: artifacts-*
+ path: target/distrib/
+ merge-multiple: true
+ - name: Install dependencies
run: |
- cd target/${{ matrix.target }}/release
- tar czf wt-${{ matrix.target }}.tar.gz wt
- mv wt-${{ matrix.target }}.tar.gz ${{ github.workspace }}/
-
- - name: πŸ“¦ Package binary (Windows)
- if: matrix.os == 'windows-latest'
+ ${{ matrix.packages_install }}
+ - name: Build artifacts
run: |
- cd target/${{ matrix.target }}/release
- 7z a wt-${{ matrix.target }}.zip wt.exe
- Move-Item wt-${{ matrix.target }}.zip ${{ github.workspace }}/
-
- - name: πŸ§ͺ Test the binary works (Unix)
- # Test native builds only - cross-compiled aarch64-unknown-linux-musl cannot be tested without QEMU
- # Windows test is separate below due to different archive format
- if: matrix.target == 'x86_64-unknown-linux-musl' || matrix.target == 'x86_64-apple-darwin' || matrix.target == 'aarch64-apple-darwin'
+ # 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: |
- mkdir -p temp_test
- tar xzf wt-${{ matrix.target }}.tar.gz -C temp_test
- ./temp_test/wt --help
+ # Parse out what we just built and upload it to scratch storage
+ echo "paths<<EOF" >> "$GITHUB_OUTPUT"
+ dist print-upload-files-from-manifest --manifest dist-manifest.json >> "$GITHUB_OUTPUT"
+ echo "EOF" >> "$GITHUB_OUTPUT"
- - name: πŸ§ͺ Test the binary works (Windows)
- if: matrix.os == 'windows-latest'
- run: |
- 7z x wt-${{ matrix.target }}.zip -otemp_test
- ./temp_test/wt.exe --help
+ 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 }}
- - name: πŸ” Generate checksums (Unix)
- if: github.event_name == 'release' && matrix.os != 'windows-latest'
- run: shasum -a 256 wt-${{ matrix.target }}.tar.gz > wt-${{ matrix.target }}.tar.gz.sha256
+ # Build and package all the platform-agnostic(ish) things
+ build-global-artifacts:
+ needs:
+ - plan
+ - build-local-artifacts
+ runs-on: "ubuntu-22.04"
+ env:
+ GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ BUILD_MANIFEST_NAME: target/distrib/global-dist-manifest.json
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ persist-credentials: false
+ 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
-
- - name: πŸ” Generate checksums (Windows)
- if: github.event_name == 'release' && matrix.os == 'windows-latest'
run: |
- $hash = (Get-FileHash -Algorithm SHA256 wt-${{ matrix.target }}.zip).Hash.ToLower()
- "$hash wt-${{ matrix.target }}.zip" | Out-File -FilePath wt-${{ matrix.target }}.zip.sha256 -Encoding ASCII
+ dist build ${{ needs.plan.outputs.tag-flag }} --output-format=json "--artifacts=global" > dist-manifest.json
+ echo "dist ran successfully"
- - name: πŸ“€ Upload release artifact
- if: github.event_name == 'release'
- uses: softprops/action-gh-release@v2
- with:
- append_body: true
- files: wt-${{ matrix.target }}.*
+ # 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"
- - name: πŸ“€ Upload build artifact (non-release)
- if: github.event_name != 'release'
+ cp dist-manifest.json "$BUILD_MANIFEST_NAME"
+ - name: "Upload artifacts"
uses: actions/upload-artifact@v4
with:
- name: wt-${{ matrix.target }}
- path: wt-${{ matrix.target }}.*
- retention-days: 7
+ 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 plan, local and global didn't fail (skipped is fine)
+ if: ${{ always() && needs.plan.result == 'success' && 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-22.04"
+ outputs:
+ val: ${{ steps.host.outputs.manifest }}
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ persist-credentials: false
+ 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/*
publish-cargo:
name: Publish to crates.io
- needs: build
+ needs:
+ - plan
+ - host
runs-on: ubuntu-latest
- # Run on stable releases, or on manual triggers for dry-run testing
- if: (github.event_name == 'release' && github.event.release.prerelease == false) || github.event_name == 'workflow_dispatch' || github.event_name == 'workflow_call'
-
+ if: ${{ needs.plan.outputs.publishing == 'true' }}
steps:
- - name: πŸ“‚ Checkout code
- uses: actions/checkout@v5
-
- - name: πŸ¦€ Install Rust
- uses: dtolnay/rust-toolchain@stable
-
- - name: πŸ“¦ Install cargo-release
- uses: baptiste0928/cargo-install@v3
- with:
- crate: cargo-release
-
- - name: βœ… Verify version matches tag
- if: github.event_name == 'release'
- run: |
- CARGO_VERSION=$(grep '^version = ' Cargo.toml | head -1 | sed 's/.*"\(.*\)".*/\1/')
- TAG_VERSION=${{ github.event.release.tag_name }}
- if [ "$CARGO_VERSION" != "$TAG_VERSION" ]; then
- echo "::error::Version mismatch: Cargo.toml has $CARGO_VERSION but tag is $TAG_VERSION"
- exit 1
- fi
- echo "Version verified: $CARGO_VERSION matches tag $TAG_VERSION"
-
- - name: πŸš€ Publish to crates.io
- run: |
- if [ "${{ github.event_name }}" = "release" ]; then
- cargo release publish --no-confirm --execute
- else
- echo "Dry-run mode - testing publish configuration without uploading"
- cargo release publish --no-confirm --dry-run --execute
- fi
+ - uses: actions/checkout@v4
+ - uses: dtolnay/rust-toolchain@stable
+ - name: Publish to crates.io
env:
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+ run: cargo publish --locked
+
+ announce:
+ needs:
+ - plan
+ - host
+ - publish-cargo
+ # 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' && (needs.publish-cargo.result == 'success' || needs.publish-cargo.result == 'skipped') }}
+ runs-on: "ubuntu-22.04"
+ env:
+ GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ persist-credentials: false
+ submodules: recursive
+ - name: Announce release
+ run: echo "Release announced successfully"
diff --git a/Cargo.toml b/Cargo.toml
index 80c81fe35..0460283f8 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -3,6 +3,7 @@ name = "worktrunk"
version = "0.1.0"
edition = "2024"
build = "build.rs"
+repository = "https://github.com/max-sixty/worktrunk"
[package.metadata.release]
# Allow releases from any branch (GitHub Actions uses detached HEAD)
@@ -72,3 +73,8 @@ harness = false
[lints.rust]
unsafe_code = "forbid"
+
+# The profile that 'dist' will build with
+[profile.dist]
+inherits = "release"
+lto = "thin"
diff --git a/dist-workspace.toml b/dist-workspace.toml
new file mode 100644
index 000000000..bb5faf59d
--- /dev/null
+++ b/dist-workspace.toml
@@ -0,0 +1,15 @@
+[workspace]
+members = ["cargo:."]
+
+# Config for 'dist'
+[dist]
+# The preferred dist version to use in CI (Cargo.toml SemVer syntax)
+cargo-dist-version = "0.30.2"
+# CI backends to support
+ci = "github"
+# The installers to generate for each app
+installers = []
+# Target platforms to build apps for (Rust target-triple syntax)
+targets = ["aarch64-apple-darwin", "x86_64-apple-darwin", "x86_64-unknown-linux-musl", "x86_64-pc-windows-msvc"]
+# Whether to install an updater program
+install-updater = false