Update cargo-dist config
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 502a5ff..6d739c5 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -1,4 +1,4 @@
-# Copyright 2022-2023, axodotdev
+# Copyright 2022-2024, axodotdev
# SPDX-License-Identifier: MIT or Apache-2.0
#
# CI that:
@@ -6,15 +6,14 @@
# * 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
+# * on success, uploads the artifacts to a GitHub Release
#
-# Note that the Github Release will be created with a generated
+# Note that the GitHub Release will be created with a generated
# title/body based on your changelogs.
name: Release
-
permissions:
- contents: write
+ "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.
@@ -31,22 +30,22 @@
# 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
+# 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]+*'
- pull_request:
jobs:
# Run 'cargo dist plan' (or host) to determine what tasks we need to do
plan:
- runs-on: ubuntu-latest
+ runs-on: "ubuntu-20.04"
outputs:
val: ${{ steps.plan.outputs.manifest }}
tag: ${{ !github.event.pull_request && github.ref_name || '' }}
@@ -62,7 +61,12 @@
# 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.12.0/cargo-dist-installer.sh | sh"
+ run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.21.0/cargo-dist-installer.sh | sh"
+ - name: Cache cargo-dist
+ uses: actions/upload-artifact@v4
+ with:
+ name: cargo-dist-cache
+ path: ~/.cargo/bin/cargo-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.
@@ -105,10 +109,12 @@
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@v4
with:
submodules: recursive
- - uses: swatinem/rust-cache@v2
- name: Install cargo-dist
run: ${{ matrix.install_dist }}
# Get the dist-manifest
@@ -135,7 +141,7 @@
run: |
# Parse out what we just built and upload it to scratch storage
echo "paths<<EOF" >> "$GITHUB_OUTPUT"
- jq --raw-output ".artifacts[]?.path | select( . != null )" dist-manifest.json >> "$GITHUB_OUTPUT"
+ jq --raw-output ".upload_files[]" dist-manifest.json >> "$GITHUB_OUTPUT"
echo "EOF" >> "$GITHUB_OUTPUT"
cp dist-manifest.json "$BUILD_MANIFEST_NAME"
@@ -160,9 +166,12 @@
- 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.12.0/cargo-dist-installer.sh | sh"
+ - name: Install cached cargo-dist
+ uses: actions/download-artifact@v4
+ with:
+ name: cargo-dist-cache
+ path: ~/.cargo/bin/
+ - run: chmod +x ~/.cargo/bin/cargo-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
@@ -178,7 +187,7 @@
# Parse out what we just built and upload it to scratch storage
echo "paths<<EOF" >> "$GITHUB_OUTPUT"
- jq --raw-output ".artifacts[]?.path | select( . != null )" dist-manifest.json >> "$GITHUB_OUTPUT"
+ jq --raw-output ".upload_files[]" dist-manifest.json >> "$GITHUB_OUTPUT"
echo "EOF" >> "$GITHUB_OUTPUT"
cp dist-manifest.json "$BUILD_MANIFEST_NAME"
@@ -206,8 +215,12 @@
- 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.12.0/cargo-dist-installer.sh | sh"
+ - name: Install cached cargo-dist
+ uses: actions/download-artifact@v4
+ with:
+ name: cargo-dist-cache
+ path: ~/.cargo/bin/
+ - run: chmod +x ~/.cargo/bin/cargo-dist
# Fetch artifacts from scratch-storage
- name: Fetch artifacts
uses: actions/download-artifact@v4
@@ -215,7 +228,6 @@
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: |
@@ -229,8 +241,29 @@
# 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
- # Create a Github Release while uploading all files to it
+ 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
@@ -246,21 +279,3 @@
- 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: |
- # 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/*"
diff --git a/Cargo.toml b/Cargo.toml
index bc9a805..400fd87 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -17,19 +17,21 @@
# Config for 'cargo dist'
[workspace.metadata.dist]
# The preferred cargo-dist version to use in CI (Cargo.toml SemVer syntax)
-cargo-dist-version = "0.12.0"
+cargo-dist-version = "0.21.0"
# CI backends to support
-ci = ["github"]
+ci = "github"
# The installers to generate for each app
installers = ["shell", "powershell"]
# Target platforms to build apps for (Rust target-triple syntax)
-targets = ["aarch64-apple-darwin", "x86_64-apple-darwin", "x86_64-unknown-linux-gnu"]
+targets = ["aarch64-apple-darwin", "x86_64-apple-darwin", "x86_64-unknown-linux-gnu", "x86_64-pc-windows-msvc"]
# Whether to consider the binaries in a package for distribution (defaults true)
dist = false
-# Publish jobs to run in CI
+# Which actions to run on pull requests
pr-run-mode = "plan"
# Whether to install an updater program
install-updater = false
+# Path that installers should place binaries in
+install-path = "CARGO_HOME"
# Config for 'cargo release'
[workspace.metadata.release]
