Skip to content

Commit 90c0697

Browse files
committed
Document each job definition with a specific comment
1 parent 00695ec commit 90c0697

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

.github/workflows/release.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,7 @@ defaults:
1717
shell: bash
1818

1919
jobs:
20-
# The create-release job runs purely to initialize the GitHub release itself,
21-
# and names the release after the version tag that was pushed. It's separate
22-
# from building the release so that we only create the release once.
20+
# Create a draft release, initially with no binary assets attached.
2321
create-release:
2422
runs-on: ubuntu-latest
2523

@@ -70,6 +68,7 @@ jobs:
7068
outputs:
7169
version: ${{ env.VERSION }}
7270

71+
# Build for a particular feature and target, and attach an archive for it.
7372
build-release:
7473
needs: [ create-release ]
7574

@@ -223,6 +222,7 @@ jobs:
223222
env:
224223
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
225224

225+
# Add a macOS universal binary archive for a feature using its built aarch64 and x86_64 assets.
226226
build-macos-universal2-release:
227227
runs-on: macos-latest
228228

@@ -286,6 +286,7 @@ jobs:
286286
env:
287287
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
288288

289+
# Check for some problems, consolidate checksum files into one, and mark the release non-draft.
289290
publish-release:
290291
runs-on: ubuntu-latest
291292

0 commit comments

Comments
 (0)