From e6e8c57697ddb543f3595cc8b2d653546b7b65cb Mon Sep 17 00:00:00 2001 From: Jacob Stephens Date: Fri, 25 Sep 2026 15:45:04 +0000 Subject: [PATCH 1/2] Build releases with dist and smoke-test the musl binary before publishing A v* tag now builds static x86_64-unknown-linux-musl and aarch64-apple-darwin binaries plus a shell installer for ~/.local/bin, runs the musl binary's `thirdshift version` on Rocky Linux 9 and in WSL2 with Ubuntu 24.04, and only then publishes the GitHub Release, with notes generated from merged pull requests. The customisations are dist custom jobs, so `dist generate` keeps them. Pull requests build without publishing; the Rocky and WSL jobs only run when a pull request touches the release pipeline or the dependencies. Co-Authored-By: Claude Opus 5.5 --- .github/workflows/release-notes.yml | 27 +++ .github/workflows/release-smoke.yml | 92 ++++++++ .github/workflows/release.yml | 319 ++++++++++++++++++++++++++++ Cargo.toml | 6 + dist-workspace.toml | 27 +++ 5 files changed, 471 insertions(+) create mode 100644 .github/workflows/release-notes.yml create mode 100644 .github/workflows/release-smoke.yml create mode 100644 .github/workflows/release.yml create mode 100644 dist-workspace.toml diff --git a/.github/workflows/release-notes.yml b/.github/workflows/release-notes.yml new file mode 100644 index 000000000..9b119f15f --- /dev/null +++ b/.github/workflows/release-notes.yml @@ -0,0 +1,27 @@ +# Sets the GitHub Release body to notes generated from the merged pull +# requests, followed by dist's install instructions. dist's release.yml calls +# this once the Release is published. There is no CHANGELOG file. +name: Release notes + +on: + workflow_call: + inputs: + plan: + required: true + type: string + +jobs: + release-notes: + runs-on: ubuntu-24.04 + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + REPO: ${{ github.repository }} + TAG: ${{ fromJson(inputs.plan).announcement_tag }} + INSTALL_NOTES: ${{ fromJson(inputs.plan).announcement_github_body }} + steps: + # Builds the body from the plan rather than the current body, so a + # re-run doesn't repeat the notes. + - run: | + gh api "repos/$REPO/releases/generate-notes" -f tag_name="$TAG" --jq .body > notes.md + printf '\n%s\n' "$INSTALL_NOTES" >> notes.md + gh release edit "$TAG" --repo "$REPO" --notes-file notes.md diff --git a/.github/workflows/release-smoke.yml b/.github/workflows/release-smoke.yml new file mode 100644 index 000000000..f1f83f92f --- /dev/null +++ b/.github/workflows/release-smoke.yml @@ -0,0 +1,92 @@ +# Runs the built musl binary's `thirdshift version` on the Linux platforms it +# has to start on, before the GitHub Release is created. dist's release.yml +# calls this after the builds, and its host job only publishes if it passes. +# +# On a tag push it always runs. On a pull request it only runs when the pull +# request touches the release pipeline or the dependencies, so ordinary pull +# requests don't pay for the slow Rocky and WSL jobs. +name: Release smoke tests + +on: + workflow_call: + inputs: + plan: + required: true + type: string + +env: + ARCHIVE: thirdshift-x86_64-unknown-linux-musl + EXPECTED: thirdshift ${{ fromJson(inputs.plan).releases[0].app_version }} + +jobs: + gate: + runs-on: ubuntu-24.04 + outputs: + run: ${{ steps.gate.outputs.run }} + steps: + # A pull request's merge commit has the base branch as its first + # parent, so diffing the two gives exactly the pull request's changes. + - uses: actions/checkout@v7 + if: github.event_name == 'pull_request' + with: + persist-credentials: false + fetch-depth: 2 + - id: gate + env: + EVENT: ${{ github.event_name }} + run: | + if [ "$EVENT" != pull_request ] || + git diff --name-only HEAD^1 HEAD | + grep -qxE '\.github/workflows/release(-smoke)?\.yml|dist-workspace\.toml|Cargo\.(toml|lock)' + then + echo "run=true" >> "$GITHUB_OUTPUT" + else + echo "run=false" >> "$GITHUB_OUTPUT" + fi + + rocky: + needs: gate + if: needs.gate.outputs.run == 'true' + runs-on: ubuntu-24.04 + steps: + - uses: actions/download-artifact@v8 + with: + name: artifacts-build-local-x86_64-unknown-linux-musl + - name: Check the binary is statically linked + run: | + tar -xJf "$ARCHIVE.tar.xz" + file "$ARCHIVE/thirdshift" | tee /dev/stderr | grep -qE 'static(-pie)? linked' + - name: Run thirdshift version in a Rocky Linux 9 container + run: | + actual=$(docker run --rm -v "$PWD/$ARCHIVE:/opt/thirdshift:ro" rockylinux:9 \ + sh -c 'cat /etc/rocky-release >&2 && /opt/thirdshift/thirdshift version') + echo "$actual" + [ "$actual" = "$EXPECTED" ] + + wsl: + needs: gate + if: needs.gate.outputs.run == 'true' + runs-on: windows-latest + defaults: + run: + shell: wsl-bash {0} + env: + # Passes these variables from Windows into WSL. + WSLENV: ARCHIVE:EXPECTED + steps: + - uses: Vampire/setup-wsl@v7 + with: + distribution: Ubuntu-24.04 + additional-packages: xz-utils + - uses: actions/download-artifact@v8 + with: + name: artifacts-build-local-x86_64-unknown-linux-musl + - name: Run thirdshift version in WSL2 with Ubuntu 24.04 + run: | + grep -q WSL2 /proc/version + grep PRETTY_NAME /etc/os-release + # Install onto the Linux filesystem, as users must, not /mnt/c. + tar -xJf "$ARCHIVE.tar.xz" -C "$HOME" + actual=$("$HOME/$ARCHIVE/thirdshift" version) + echo "$actual" + [ "$actual" = "$EXPECTED" ] diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 000000000..c266cee03 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,319 @@ +# This file was autogenerated by dist: https://axodotdev.github.io/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: + pull_request: + 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-24.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@v6 + 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.33.0/cargo-dist-installer.sh | sh" + - name: Cache dist + uses: actions/upload-artifact@v7 + 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@v7 + 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 }} + 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: enable windows longpaths + run: | + git config --global core.longpaths true + - uses: actions/checkout@v6 + 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 + - uses: swatinem/rust-cache@v2 + with: + key: ${{ join(matrix.targets, '-') }} + cache-provider: ${{ matrix.cache_provider }} + - name: Install dist + run: ${{ matrix.install_dist.run }} + # Get the dist-manifest + - name: Fetch local artifacts + uses: actions/download-artifact@v8 + 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<> "$GITHUB_OUTPUT" + dist print-upload-files-from-manifest --manifest dist-manifest.json >> "$GITHUB_OUTPUT" + echo "EOF" >> "$GITHUB_OUTPUT" + + cp dist-manifest.json "$BUILD_MANIFEST_NAME" + - name: "Upload artifacts" + uses: actions/upload-artifact@v7 + 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-24.04" + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BUILD_MANIFEST_NAME: target/distrib/global-dist-manifest.json + steps: + - uses: actions/checkout@v6 + with: + persist-credentials: false + submodules: recursive + - name: Install cached dist + uses: actions/download-artifact@v8 + 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@v8 + 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<> "$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@v7 + with: + name: artifacts-build-global + path: | + ${{ steps.cargo-dist.outputs.paths }} + ${{ env.BUILD_MANIFEST_NAME }} + + custom-release-smoke: + needs: + - plan + - build-local-artifacts + uses: ./.github/workflows/release-smoke.yml + with: + plan: ${{ needs.plan.outputs.val }} + secrets: inherit + # Determines if we should publish/announce + host: + needs: + - plan + - build-local-artifacts + - build-global-artifacts + - custom-release-smoke + # 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.custom-release-smoke.result == 'skipped' || needs.custom-release-smoke.result == 'success') && (needs.build-local-artifacts.result == 'skipped' || needs.build-local-artifacts.result == 'success') }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + runs-on: "ubuntu-24.04" + outputs: + val: ${{ steps.host.outputs.manifest }} + steps: + - uses: actions/checkout@v6 + with: + persist-credentials: false + submodules: recursive + - name: Install cached dist + uses: actions/download-artifact@v8 + 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@v8 + 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@v7 + 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@v8 + 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-24.04" + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v6 + with: + persist-credentials: false + submodules: recursive + + custom-release-notes: + needs: + - plan + - announce + uses: ./.github/workflows/release-notes.yml + with: + plan: ${{ needs.plan.outputs.val }} + secrets: inherit diff --git a/Cargo.toml b/Cargo.toml index b51277cc0..01cd28ff2 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,6 +3,7 @@ name = "thirdshift" version = "0.1.0" edition = "2024" description = "Turn a GitHub issue into a ready-for-review pull request, unattended" +repository = "https://github.com/JacobStephens2/thirdshift" [dependencies] anyhow = "1.0.104" @@ -12,3 +13,8 @@ libc = "0.2.189" serde_json = "1.0.151" signal-hook = "0.4.4" tempfile = "3.27.0" + +# 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..7d66cc1c0 --- /dev/null +++ b/dist-workspace.toml @@ -0,0 +1,27 @@ +[workspace] +members = ["cargo:."] + +# Config for 'dist'. Change it here, then run `dist generate` to regenerate +# .github/workflows/release.yml; never edit that file by hand. +[dist] +cargo-dist-version = "0.33.0" +ci = "github" +targets = ["x86_64-unknown-linux-musl", "aarch64-apple-darwin"] +installers = ["shell"] +install-path = "~/.local/bin" +# The installer still writes the install receipt that `thirdshift update` +# reads; the updater is built into the binary, not shipped beside it. +install-updater = false +# Build on every pull request without publishing. The slow Rocky and WSL +# checks in release-smoke.yml decide for themselves whether to run. +pr-run-mode = "upload" +# Runs after the builds; the GitHub Release is only created if it passes. +global-artifacts-jobs = ["./release-smoke"] +# Replaces the Release body with notes generated from the merged pull requests. +post-announce-jobs = ["./release-notes"] + +# The runner images are pinned to the platforms thirdshift supports, as in ci.yml. +[dist.github-custom-runners] +global = "ubuntu-24.04" +x86_64-unknown-linux-musl = "ubuntu-24.04" +aarch64-apple-darwin = "macos-26" From 6f3e45017069662699822f2d75dfacb1f6a474b6 Mon Sep 17 00:00:00 2001 From: Jacob Stephens Date: Fri, 25 Sep 2026 15:47:31 +0000 Subject: [PATCH 2/2] Address review: gate on every release workflow, one artifact name, no source tarball Co-Authored-By: Claude Opus 5.5 --- .github/workflows/release-smoke.yml | 7 ++++--- dist-workspace.toml | 2 ++ 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/workflows/release-smoke.yml b/.github/workflows/release-smoke.yml index f1f83f92f..61a920c4a 100644 --- a/.github/workflows/release-smoke.yml +++ b/.github/workflows/release-smoke.yml @@ -16,6 +16,7 @@ on: env: ARCHIVE: thirdshift-x86_64-unknown-linux-musl + ARTIFACT: artifacts-build-local-x86_64-unknown-linux-musl EXPECTED: thirdshift ${{ fromJson(inputs.plan).releases[0].app_version }} jobs: @@ -37,7 +38,7 @@ jobs: run: | if [ "$EVENT" != pull_request ] || git diff --name-only HEAD^1 HEAD | - grep -qxE '\.github/workflows/release(-smoke)?\.yml|dist-workspace\.toml|Cargo\.(toml|lock)' + grep -qxE '\.github/workflows/release.*\.yml|dist-workspace\.toml|Cargo\.(toml|lock)' then echo "run=true" >> "$GITHUB_OUTPUT" else @@ -51,7 +52,7 @@ jobs: steps: - uses: actions/download-artifact@v8 with: - name: artifacts-build-local-x86_64-unknown-linux-musl + name: ${{ env.ARTIFACT }} - name: Check the binary is statically linked run: | tar -xJf "$ARCHIVE.tar.xz" @@ -80,7 +81,7 @@ jobs: additional-packages: xz-utils - uses: actions/download-artifact@v8 with: - name: artifacts-build-local-x86_64-unknown-linux-musl + name: ${{ env.ARTIFACT }} - name: Run thirdshift version in WSL2 with Ubuntu 24.04 run: | grep -q WSL2 /proc/version diff --git a/dist-workspace.toml b/dist-workspace.toml index 7d66cc1c0..96e9471a4 100644 --- a/dist-workspace.toml +++ b/dist-workspace.toml @@ -9,6 +9,8 @@ ci = "github" targets = ["x86_64-unknown-linux-musl", "aarch64-apple-darwin"] installers = ["shell"] install-path = "~/.local/bin" +# Only the binaries and the installer are published. +source-tarball = false # The installer still writes the install receipt that `thirdshift update` # reads; the updater is built into the binary, not shipped beside it. install-updater = false