aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEllie Huxtable <ellie@atuin.sh>2024-12-05 23:05:13 +0000
committerGitHub <noreply@github.com>2024-12-05 23:05:13 +0000
commit2654dc43915a5685a7591f18578ea9fd5d83cd4d (patch)
treec65b1903eb2c664d3db51e14bab2da1e5511f5ef
parentchore(release): prepare for release 18.4.0-beta.4 (#2469) (diff)
downloadatuin-2654dc43915a5685a7591f18578ea9fd5d83cd4d.zip
chore: update cargo-dist (#2471)
Diffstat (limited to '')
-rw-r--r--.github/workflows/release.yml114
-rw-r--r--Cargo.toml33
-rw-r--r--dist-workspace.toml28
3 files changed, 89 insertions, 86 deletions
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index dda22ed0..c72faf54 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -1,10 +1,12 @@
+# 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 cargo-dist (archives, installers, hashes)
+# * builds artifacts with dist (archives, installers, hashes)
# * uploads those artifacts to temporary workflow zip
# * on success, uploads the artifacts to a GitHub Release
#
@@ -12,11 +14,10 @@
# title/body based on your changelogs.
name: Release
-
permissions:
- contents: write
- id-token: write
- attestations: write
+ "attestations": "write"
+ "contents": "write"
+ "id-token": "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.
@@ -25,10 +26,10 @@ permissions:
# 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 cargo-dist-able).
+# 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
-# (cargo-dist-able) packages in the workspace with that version (this mode is
+# (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).
#
@@ -46,7 +47,7 @@ on:
- '**[0-9]+.[0-9]+.[0-9]+*'
jobs:
- # Run 'cargo dist plan' (or host) to determine what tasks we need to do
+ # Run 'dist plan' (or host) to determine what tasks we need to do
plan:
runs-on: "ubuntu-20.04"
outputs:
@@ -60,11 +61,16 @@ jobs:
- uses: actions/checkout@v4
with:
submodules: recursive
- - name: Install cargo-dist
+ - 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.16.0/cargo-dist-installer.sh | sh"
+ 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.
@@ -72,8 +78,8 @@ jobs:
# but also really annoying to build CI around when it needs secrets to work right.)
- id: plan
run: |
- 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"
+ 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"
@@ -91,12 +97,12 @@ jobs:
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.
+ # 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 cargo dist
- # - install-dist: expression to run to install cargo-dist on the 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
@@ -113,11 +119,7 @@ jobs:
- uses: actions/checkout@v4
with:
submodules: recursive
- - uses: swatinem/rust-cache@v2
- with:
- key: ${{ join(matrix.targets, '-') }}
- cache-provider: ${{ matrix.cache_provider }}
- - name: Install cargo-dist
+ - name: Install dist
run: ${{ matrix.install_dist }}
# Get the dist-manifest
- name: Fetch local artifacts
@@ -132,8 +134,8 @@ jobs:
- 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"
+ dist build ${{ needs.plan.outputs.tag-flag }} --print=linkage --output-format=json ${{ matrix.dist_args }} > dist-manifest.json
+ echo "dist ran successfully"
- name: Attest
uses: actions/attest-build-provenance@v1
with:
@@ -172,9 +174,12 @@ jobs:
- 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.16.0/cargo-dist-installer.sh | sh"
+ - 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
@@ -185,8 +190,8 @@ jobs:
- 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"
+ 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"
@@ -218,8 +223,12 @@ jobs:
- 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.16.0/cargo-dist-installer.sh | sh"
+ - 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
@@ -227,11 +236,10 @@ jobs:
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: |
- cargo dist host ${{ needs.plan.outputs.tag-flag }} --steps=upload --steps=release --output-format=json > dist-manifest.json
+ 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"
@@ -241,23 +249,7 @@ jobs:
# Overwrite the previous copy
name: artifacts-dist-manifest
path: dist-manifest.json
-
- # 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@v4
- with:
- submodules: recursive
+ # Create a GitHub Release while uploading all files to it
- name: "Download GitHub Artifacts"
uses: actions/download-artifact@v4
with:
@@ -270,12 +262,28 @@ jobs:
rm -f artifacts/*-dist-manifest.json
- name: Create GitHub Release
env:
- PRERELEASE_FLAG: "${{ fromJson(needs.host.outputs.val).announcement_is_prerelease && '--prerelease' || '' }}"
- ANNOUNCEMENT_TITLE: "${{ fromJson(needs.host.outputs.val).announcement_title }}"
- ANNOUNCEMENT_BODY: "${{ fromJson(needs.host.outputs.val).announcement_github_body }}"
+ 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 }}" --title "$ANNOUNCEMENT_TITLE" --notes-file "$RUNNER_TEMP/notes.txt" $PRERELEASE_FLAG
- gh release upload "${{ needs.plan.outputs.tag }}" artifacts/*
+ 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
diff --git a/Cargo.toml b/Cargo.toml
index d4e251a2..2c11edbd 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -56,40 +56,7 @@ default-features = false
version = "0.8"
features = ["runtime-tokio-rustls", "time", "postgres", "uuid"]
-# Config for 'cargo dist'
-[workspace.metadata.dist]
-# Path that installers should place binaries in
-install-path = "~/.atuin/bin"
-# The preferred cargo-dist version to use in CI (Cargo.toml SemVer syntax)
-cargo-dist-version = "0.16.0"
-# CI backends to support
-ci = "github"
-# The installers to generate for each app
-installers = ["shell"]
-# Target platforms to build apps for (Rust target-triple syntax)
-targets = [
- "aarch64-apple-darwin",
- "aarch64-unknown-linux-gnu",
- "aarch64-unknown-linux-musl",
- "x86_64-apple-darwin",
- "x86_64-unknown-linux-gnu",
- "x86_64-unknown-linux-musl",
-]
-# Publish jobs to run in CI
-pr-run-mode = "plan"
-# Whether to install an updater program
-install-updater = true
-# The archive format to use for non-windows builds (defaults .tar.xz)
-unix-archive = ".tar.gz"
-# Whether to enable GitHub Attestations
-github-attestations = true
-
# The profile that 'cargo dist' will build with
[profile.dist]
inherits = "release"
lto = "thin"
-
-[workspace.metadata.dist.github-custom-runners]
-aarch64-apple-darwin = "macos-14"
-aarch64-unknown-linux-gnu = "buildjet-2vcpu-ubuntu-2204-arm"
-aarch64-unknown-linux-musl = "buildjet-2vcpu-ubuntu-2204-arm"
diff --git a/dist-workspace.toml b/dist-workspace.toml
new file mode 100644
index 00000000..ae914ae6
--- /dev/null
+++ b/dist-workspace.toml
@@ -0,0 +1,28 @@
+[workspace]
+members = ["cargo:."]
+
+# Config for 'dist'
+[dist]
+# Path that installers should place binaries in
+install-path = "~/.atuin/bin"
+# The preferred dist version to use in CI (Cargo.toml SemVer syntax)
+cargo-dist-version = "0.25.1"
+# CI backends to support
+ci = "github"
+# The installers to generate for each app
+installers = ["shell"]
+# Target platforms to build apps for (Rust target-triple syntax)
+targets = ["aarch64-apple-darwin", "aarch64-unknown-linux-gnu", "aarch64-unknown-linux-musl", "x86_64-apple-darwin", "x86_64-unknown-linux-gnu", "x86_64-unknown-linux-musl"]
+# Which actions to run on pull requests
+pr-run-mode = "plan"
+# Whether to install an updater program
+install-updater = true
+# The archive format to use for non-windows builds (defaults .tar.xz)
+unix-archive = ".tar.gz"
+# Whether to enable GitHub Attestations
+github-attestations = true
+
+[dist.github-custom-runners]
+aarch64-apple-darwin = "macos-14"
+aarch64-unknown-linux-gnu = "buildjet-2vcpu-ubuntu-2204-arm"
+aarch64-unknown-linux-musl = "buildjet-2vcpu-ubuntu-2204-arm"