Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit ddd00d4

Browse files
pvdrzpvdrz
committedOct 8, 2024··
Update cargo-dist
·
v0.69.5
1 parent 834c78b commit ddd00d4

File tree

2 files changed

+171
-71
lines changed

2 files changed

+171
-71
lines changed
 

‎.github/workflows/release.yml

+158-66
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,53 @@
1-
# Copyright 2022-2023, axodotdev
1+
# This file was autogenerated by cargo-dist: https://opensource.axo.dev/cargo-dist/
2+
#
3+
# Copyright 2022-2024, axodotdev
24
# SPDX-License-Identifier: MIT or Apache-2.0
35
#
46
# CI that:
57
#
68
# * checks for a Git Tag that looks like a release
79
# * builds artifacts with cargo-dist (archives, installers, hashes)
810
# * uploads those artifacts to temporary workflow zip
9-
# * on success, uploads the artifacts to a Github Release™
11+
# * on success, uploads the artifacts to a GitHub Release
1012
#
11-
# Note that the Github Release™ will be created with a generated
13+
# Note that the GitHub Release will be created with a generated
1214
# title/body based on your changelogs.
13-
name: Release
1415

16+
name: Release
1517
permissions:
16-
contents: write
18+
"contents": "write"
1719

1820
# This task will run whenever you push a git tag that looks like a version
1921
# like "1.0.0", "v0.1.0-prerelease.1", "my-app/0.1.0", "releases/v1.0.0", etc.
2022
# Various formats will be parsed into a VERSION and an optional PACKAGE_NAME, where
2123
# PACKAGE_NAME must be the name of a Cargo package in your workspace, and VERSION
2224
# must be a Cargo-style SemVer Version (must have at least major.minor.patch).
2325
#
24-
# If PACKAGE_NAME is specified, then the release will be for that
26+
# If PACKAGE_NAME is specified, then the announcement will be for that
2527
# package (erroring out if it doesn't have the given version or isn't cargo-dist-able).
2628
#
27-
# If PACKAGE_NAME isn't specified, then the release will be for all
29+
# If PACKAGE_NAME isn't specified, then the announcement will be for all
2830
# (cargo-dist-able) packages in the workspace with that version (this mode is
2931
# intended for workspaces with only one dist-able package, or with all dist-able
3032
# packages versioned/released in lockstep).
3133
#
3234
# If you push multiple tags at once, separate instances of this workflow will
33-
# spin up, creating an independent Github Release™ for each one. However Github
35+
# spin up, creating an independent announcement for each one. However, GitHub
3436
# will hard limit this to 3 tags per commit, as it will assume more tags is a
3537
# mistake.
3638
#
37-
# If there's a prerelease-style suffix to the version, then the Github Release™
39+
# If there's a prerelease-style suffix to the version, then the release(s)
3840
# will be marked as a prerelease.
3941
on:
42+
pull_request:
4043
push:
4144
tags:
4245
- '**[0-9]+.[0-9]+.[0-9]+*'
43-
pull_request:
4446

4547
jobs:
46-
# Run 'cargo dist plan' to determine what tasks we need to do
48+
# Run 'cargo dist plan' (or host) to determine what tasks we need to do
4749
plan:
48-
runs-on: ubuntu-latest
50+
runs-on: "ubuntu-20.04"
4951
outputs:
5052
val: ${{ steps.plan.outputs.manifest }}
5153
tag: ${{ !github.event.pull_request && github.ref_name || '' }}
@@ -58,24 +60,39 @@ jobs:
5860
with:
5961
submodules: recursive
6062
- name: Install cargo-dist
61-
run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.3.1/cargo-dist-installer.sh | sh"
63+
# we specify bash to get pipefail; it guards against the `curl` command
64+
# failing. otherwise `sh` won't catch that `curl` returned non-0
65+
shell: bash
66+
run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.22.1/cargo-dist-installer.sh | sh"
67+
- name: Cache cargo-dist
68+
uses: actions/upload-artifact@v4
69+
with:
70+
name: cargo-dist-cache
71+
path: ~/.cargo/bin/cargo-dist
72+
# sure would be cool if github gave us proper conditionals...
73+
# so here's a doubly-nested ternary-via-truthiness to try to provide the best possible
74+
# functionality based on whether this is a pull_request, and whether it's from a fork.
75+
# (PRs run on the *source* but secrets are usually on the *target* -- that's *good*
76+
# but also really annoying to build CI around when it needs secrets to work right.)
6277
- id: plan
6378
run: |
64-
cargo dist plan ${{ !github.event.pull_request && format('--tag={0}', github.ref_name) || '' }} --output-format=json > dist-manifest.json
65-
echo "cargo dist plan ran successfully"
66-
cat dist-manifest.json
67-
echo "manifest=$(jq -c "." dist-manifest.json)" >> "$GITHUB_OUTPUT"
79+
cargo dist ${{ (!github.event.pull_request && format('host --steps=create --tag={0}', github.ref_name)) || 'plan' }} --output-format=json > plan-dist-manifest.json
80+
echo "cargo dist ran successfully"
81+
cat plan-dist-manifest.json
82+
echo "manifest=$(jq -c "." plan-dist-manifest.json)" >> "$GITHUB_OUTPUT"
6883
- name: "Upload dist-manifest.json"
69-
uses: actions/upload-artifact@v3
84+
uses: actions/upload-artifact@v4
7085
with:
71-
name: artifacts
72-
path: dist-manifest.json
86+
name: artifacts-plan-dist-manifest
87+
path: plan-dist-manifest.json
7388

7489
# Build and packages all the platform-specific things
75-
upload-local-artifacts:
90+
build-local-artifacts:
91+
name: build-local-artifacts (${{ join(matrix.targets, ', ') }})
7692
# Let the initial task tell us to not run (currently very blunt)
77-
needs: plan
78-
if: ${{ fromJson(needs.plan.outputs.val).releases != null && (needs.plan.outputs.publishing == 'true' || fromJson(needs.plan.outputs.val).ci.github.pr_run_mode == 'upload') }}
93+
needs:
94+
- plan
95+
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') }}
7996
strategy:
8097
fail-fast: false
8198
# Target platforms/runners are computed by cargo-dist in create-release.
@@ -92,17 +109,30 @@ jobs:
92109
runs-on: ${{ matrix.runner }}
93110
env:
94111
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
112+
BUILD_MANIFEST_NAME: target/distrib/${{ join(matrix.targets, '-') }}-dist-manifest.json
95113
steps:
114+
- name: enable windows longpaths
115+
run: |
116+
git config --global core.longpaths true
96117
- uses: actions/checkout@v4
97118
with:
98119
submodules: recursive
99-
- uses: swatinem/rust-cache@v2
100120
- name: Install cargo-dist
101121
run: ${{ matrix.install_dist }}
122+
# Get the dist-manifest
123+
- name: Fetch local artifacts
124+
uses: actions/download-artifact@v4
125+
with:
126+
pattern: artifacts-*
127+
path: target/distrib/
128+
merge-multiple: true
129+
- name: Install dependencies
130+
run: |
131+
${{ matrix.packages_install }}
102132
- name: Build artifacts
103133
run: |
104134
# Actually do builds and make zips and whatnot
105-
cargo dist build ${{ needs.plan.outputs.tag-flag }} --output-format=json ${{ matrix.dist_args }} > dist-manifest.json
135+
cargo dist build ${{ needs.plan.outputs.tag-flag }} --print=linkage --output-format=json ${{ matrix.dist_args }} > dist-manifest.json
106136
echo "cargo dist ran successfully"
107137
- id: cargo-dist
108138
name: Post-build
@@ -111,81 +141,143 @@ jobs:
111141
# inconsistent syntax between shell and powershell.
112142
shell: bash
113143
run: |
114-
# Parse out what we just built and upload it to the Github Release™
144+
# Parse out what we just built and upload it to scratch storage
115145
echo "paths<<EOF" >> "$GITHUB_OUTPUT"
116-
jq --raw-output ".artifacts[]?.path | select( . != null )" dist-manifest.json >> "$GITHUB_OUTPUT"
146+
jq --raw-output ".upload_files[]" dist-manifest.json >> "$GITHUB_OUTPUT"
117147
echo "EOF" >> "$GITHUB_OUTPUT"
148+
149+
cp dist-manifest.json "$BUILD_MANIFEST_NAME"
118150
- name: "Upload artifacts"
119-
uses: actions/upload-artifact@v3
151+
uses: actions/upload-artifact@v4
120152
with:
121-
name: artifacts
122-
path: ${{ steps.cargo-dist.outputs.paths }}
153+
name: artifacts-build-local-${{ join(matrix.targets, '_') }}
154+
path: |
155+
${{ steps.cargo-dist.outputs.paths }}
156+
${{ env.BUILD_MANIFEST_NAME }}
123157
124158
# Build and package all the platform-agnostic(ish) things
125-
upload-global-artifacts:
126-
needs: [plan, upload-local-artifacts]
159+
build-global-artifacts:
160+
needs:
161+
- plan
162+
- build-local-artifacts
127163
runs-on: "ubuntu-20.04"
128164
env:
129165
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
166+
BUILD_MANIFEST_NAME: target/distrib/global-dist-manifest.json
130167
steps:
131168
- uses: actions/checkout@v4
132169
with:
133170
submodules: recursive
134-
- name: Install cargo-dist
135-
run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.3.1/cargo-dist-installer.sh | sh"
171+
- name: Install cached cargo-dist
172+
uses: actions/download-artifact@v4
173+
with:
174+
name: cargo-dist-cache
175+
path: ~/.cargo/bin/
176+
- run: chmod +x ~/.cargo/bin/cargo-dist
136177
# Get all the local artifacts for the global tasks to use (for e.g. checksums)
137178
- name: Fetch local artifacts
138-
uses: actions/download-artifact@v3
179+
uses: actions/download-artifact@v4
139180
with:
140-
name: artifacts
181+
pattern: artifacts-*
141182
path: target/distrib/
183+
merge-multiple: true
142184
- id: cargo-dist
143185
shell: bash
144186
run: |
145187
cargo dist build ${{ needs.plan.outputs.tag-flag }} --output-format=json "--artifacts=global" > dist-manifest.json
146188
echo "cargo dist ran successfully"
147189
148-
# Parse out what we just built and upload it to the Github Release™
190+
# Parse out what we just built and upload it to scratch storage
149191
echo "paths<<EOF" >> "$GITHUB_OUTPUT"
150-
jq --raw-output ".artifacts[]?.path | select( . != null )" dist-manifest.json >> "$GITHUB_OUTPUT"
192+
jq --raw-output ".upload_files[]" dist-manifest.json >> "$GITHUB_OUTPUT"
151193
echo "EOF" >> "$GITHUB_OUTPUT"
194+
195+
cp dist-manifest.json "$BUILD_MANIFEST_NAME"
152196
- name: "Upload artifacts"
153-
uses: actions/upload-artifact@v3
197+
uses: actions/upload-artifact@v4
154198
with:
155-
name: artifacts
156-
path: ${{ steps.cargo-dist.outputs.paths }}
157-
158-
should-publish:
199+
name: artifacts-build-global
200+
path: |
201+
${{ steps.cargo-dist.outputs.paths }}
202+
${{ env.BUILD_MANIFEST_NAME }}
203+
# Determines if we should publish/announce
204+
host:
159205
needs:
160206
- plan
161-
- upload-local-artifacts
162-
- upload-global-artifacts
163-
if: ${{ needs.plan.outputs.publishing == 'true' }}
164-
runs-on: ubuntu-latest
165-
steps:
166-
- name: print tag
167-
run: echo "ok we're publishing!"
168-
169-
# Create a Github Release with all the results once everything is done,
170-
publish-release:
171-
needs: [plan, should-publish]
172-
runs-on: ubuntu-latest
207+
- build-local-artifacts
208+
- build-global-artifacts
209+
# Only run if we're "publishing", and only if local and global didn't fail (skipped is fine)
210+
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') }}
173211
env:
174212
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
213+
runs-on: "ubuntu-20.04"
214+
outputs:
215+
val: ${{ steps.host.outputs.manifest }}
175216
steps:
176217
- uses: actions/checkout@v4
177218
with:
178219
submodules: recursive
179-
- name: "Download artifacts"
180-
uses: actions/download-artifact@v3
220+
- name: Install cached cargo-dist
221+
uses: actions/download-artifact@v4
222+
with:
223+
name: cargo-dist-cache
224+
path: ~/.cargo/bin/
225+
- run: chmod +x ~/.cargo/bin/cargo-dist
226+
# Fetch artifacts from scratch-storage
227+
- name: Fetch artifacts
228+
uses: actions/download-artifact@v4
229+
with:
230+
pattern: artifacts-*
231+
path: target/distrib/
232+
merge-multiple: true
233+
- id: host
234+
shell: bash
235+
run: |
236+
cargo dist host ${{ needs.plan.outputs.tag-flag }} --steps=upload --steps=release --output-format=json > dist-manifest.json
237+
echo "artifacts uploaded and released successfully"
238+
cat dist-manifest.json
239+
echo "manifest=$(jq -c "." dist-manifest.json)" >> "$GITHUB_OUTPUT"
240+
- name: "Upload dist-manifest.json"
241+
uses: actions/upload-artifact@v4
242+
with:
243+
# Overwrite the previous copy
244+
name: artifacts-dist-manifest
245+
path: dist-manifest.json
246+
# Create a GitHub Release while uploading all files to it
247+
- name: "Download GitHub Artifacts"
248+
uses: actions/download-artifact@v4
181249
with:
182-
name: artifacts
250+
pattern: artifacts-*
183251
path: artifacts
184-
- name: Create Release
185-
uses: ncipollo/release-action@v1
186-
with:
187-
tag: ${{ needs.plan.outputs.tag }}
188-
name: ${{ fromJson(needs.plan.outputs.val).announcement_title }}
189-
body: ${{ fromJson(needs.plan.outputs.val).announcement_github_body }}
190-
prerelease: ${{ fromJson(needs.plan.outputs.val).announcement_is_prerelease }}
191-
artifacts: "artifacts/*"
252+
merge-multiple: true
253+
- name: Cleanup
254+
run: |
255+
# Remove the granular manifests
256+
rm -f artifacts/*-dist-manifest.json
257+
- name: Create GitHub Release
258+
env:
259+
PRERELEASE_FLAG: "${{ fromJson(steps.host.outputs.manifest).announcement_is_prerelease && '--prerelease' || '' }}"
260+
ANNOUNCEMENT_TITLE: "${{ fromJson(steps.host.outputs.manifest).announcement_title }}"
261+
ANNOUNCEMENT_BODY: "${{ fromJson(steps.host.outputs.manifest).announcement_github_body }}"
262+
RELEASE_COMMIT: "${{ github.sha }}"
263+
run: |
264+
# Write and read notes from a file to avoid quoting breaking things
265+
echo "$ANNOUNCEMENT_BODY" > $RUNNER_TEMP/notes.txt
266+
267+
gh release create "${{ needs.plan.outputs.tag }}" --target "$RELEASE_COMMIT" $PRERELEASE_FLAG --title "$ANNOUNCEMENT_TITLE" --notes-file "$RUNNER_TEMP/notes.txt" artifacts/*
268+
269+
announce:
270+
needs:
271+
- plan
272+
- host
273+
# use "always() && ..." to allow us to wait for all publish jobs while
274+
# still allowing individual publish jobs to skip themselves (for prereleases).
275+
# "host" however must run to completion, no skipping allowed!
276+
if: ${{ always() && needs.host.result == 'success' }}
277+
runs-on: "ubuntu-20.04"
278+
env:
279+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
280+
steps:
281+
- uses: actions/checkout@v4
282+
with:
283+
submodules: recursive

‎Cargo.toml

+13-5
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,25 @@ default-members = [
1717
# Config for 'cargo dist'
1818
[workspace.metadata.dist]
1919
# The preferred cargo-dist version to use in CI (Cargo.toml SemVer syntax)
20-
cargo-dist-version = "0.3.1"
20+
cargo-dist-version = "0.22.1"
2121
# CI backends to support
22-
ci = ["github"]
22+
ci = "github"
2323
# The installers to generate for each app
24-
installers = ["shell", "powershell"]
24+
installers = ["shell"]
2525
# Target platforms to build apps for (Rust target-triple syntax)
26-
targets = ["x86_64-unknown-linux-gnu", "aarch64-apple-darwin", "x86_64-apple-darwin"]
26+
targets = ["aarch64-apple-darwin", "x86_64-apple-darwin", "x86_64-unknown-linux-gnu"]
2727
# Whether to consider the binaries in a package for distribution (defaults true)
2828
dist = false
29-
# Publish jobs to run in CI
29+
# Which actions to run on pull requests
3030
pr-run-mode = "plan"
31+
# Path that installers should place binaries in
32+
install-path = "CARGO_HOME"
33+
# Whether to install an updater program
34+
install-updater = false
35+
36+
[workspace.metadata.dist.github-custom-runners]
37+
aarch64-apple-darwin = "macos-14"
38+
x86_64-apple-darwin = "macos-12"
3139

3240
# Config for 'cargo release'
3341
[workspace.metadata.release]

0 commit comments

Comments
 (0)
Please sign in to comment.