Skip to content

Commit ff49d27

Browse files
committed
chore: rename job ids to actionable names/verbs
1 parent 66fc8df commit ff49d27

5 files changed

Lines changed: 29 additions & 29 deletions

File tree

.github/workflows/_build.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ on:
2929
description: Enable or disable running pip_audit to check installed packages for vulnerabilities
3030
outputs:
3131
artifacts-sha256:
32-
value: ${{ jobs.build-package.outputs.artifacts-sha256 }}
32+
value: ${{ jobs.check-and-build-package.outputs.artifacts-sha256 }}
3333
description: The hash of the artifacts
3434
permissions:
3535
contents: read
@@ -38,7 +38,7 @@ env:
3838
ARTIFACT_PYTHON: '3.13' # The default Python version for release.
3939

4040
jobs:
41-
build-package:
41+
check-and-build-package:
4242
# Uncomment the following to disable checks and tests for Draft pull requests.
4343
# if: github.event.pull_request.draft == false
4444
outputs:

.github/workflows/_release-notifications.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ on:
2525
permissions: {}
2626

2727
jobs:
28-
release-notification-slack:
28+
send-release-notification-slack:
2929
name: Slack release notification
3030
runs-on: ubuntu-latest
3131
steps:

.github/workflows/pr-change-set.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ permissions:
1515
contents: read
1616

1717
jobs:
18-
pr-build-package:
18+
build-package:
1919
uses: ./.github/workflows/_build.yaml
2020
permissions:
2121
contents: read

.github/workflows/pr-conventional-commits.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ permissions:
1717
contents: read
1818

1919
jobs:
20-
pr-check-conventional-commits:
20+
check-conventional-commits:
2121
runs-on: ubuntu-latest
2222
steps:
2323

.github/workflows/release.yaml

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ permissions:
1111
contents: read
1212

1313
jobs:
14-
release-check:
14+
check-package-for-release:
1515
if: ${{ !startsWith(github.event.commits[0].message, 'bump:') }}
1616
uses: ./.github/workflows/_build.yaml
1717
permissions:
@@ -21,8 +21,8 @@ jobs:
2121

2222
# On pushes to the 'release' branch create a new release by bumping the version
2323
# and generating a change log. That's the new bump commit and associated tag.
24-
release-bump:
25-
needs: [release-check]
24+
bump-package-version:
25+
needs: [check-package-for-release]
2626
if: github.ref == 'refs/heads/release'
2727
runs-on: ubuntu-latest
2828
permissions:
@@ -76,7 +76,7 @@ jobs:
7676
git push --tags
7777
7878
# When triggered by the version bump commit, build the package and publish the release artifacts.
79-
release-build:
79+
build-package-for-release:
8080
if: github.ref == 'refs/heads/release' && startsWith(github.event.commits[0].message, 'bump:')
8181
uses: ./.github/workflows/_build.yaml
8282
permissions:
@@ -86,8 +86,8 @@ jobs:
8686

8787
# Create a new Release on Github from the verified build artifacts, and optionally
8888
# publish the artifacts to a PyPI server.
89-
release:
90-
needs: [release-build]
89+
release-package:
90+
needs: [build-package-for-release]
9191
name: Release
9292
outputs:
9393
release-tag: ${{ steps.upload-assets.outputs.release-tag }}
@@ -118,7 +118,7 @@ jobs:
118118
# against the hashes computed by the build job.
119119
- name: Verify the artifact hash
120120
env:
121-
ARTIFACT_HASH: ${{ needs.release-build.outputs.artifacts-sha256 }}
121+
ARTIFACT_HASH: ${{ needs.build-package-for-release.outputs.artifacts-sha256 }}
122122
run: |
123123
set -euo pipefail
124124
echo "Hash of package should be $ARTIFACT_HASH."
@@ -175,11 +175,11 @@ jobs:
175175
# provenance generator which depends on an external service Rekor (https://github.com/sigstore/rekor)
176176
# we build this generator from source for now. For more information see this discussion:
177177
# https://github.com/slsa-framework/slsa-github-generator/issues/942
178-
release-provenance:
179-
needs: [release-build, release]
178+
generate-provenance:
179+
needs: [build-package-for-release, release-package]
180180
uses: slsa-framework/slsa-github-generator/.github/workflows/[email protected]
181181
with:
182-
base64-subjects: ${{ needs.release-build.outputs.artifacts-sha256 }}
182+
base64-subjects: ${{ needs.build-package-for-release.outputs.artifacts-sha256 }}
183183
compile-generator: false # Do not build the provenance generator from source anymore.
184184
# Set private-repository to true for private repositories. Note that the repository name is
185185
# uploaded as part of the transparency log entry on the public Rekor instance (rekor.sigstore.dev).
@@ -190,8 +190,8 @@ jobs:
190190
contents: write # To add assets to a release.
191191

192192
# Publish the SLSA provenance as the GitHub release asset.
193-
release-publish_provenance:
194-
needs: [release, release-provenance]
193+
release-provenance:
194+
needs: [release-package, generate-provenance]
195195
name: Publish provenance
196196
runs-on: ubuntu-latest
197197
permissions:
@@ -212,41 +212,41 @@ jobs:
212212
- name: Download provenance
213213
uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
214214
with:
215-
name: ${{ needs.release-provenance.outputs.provenance-name }}
215+
name: ${{ needs.generate-provenance.outputs.provenance-name }}
216216

217217
- name: Upload provenance
218-
run: gh release upload ${{ needs.release.outputs.release-tag }} ${{ needs.release-provenance.outputs.provenance-name }}
218+
run: gh release upload ${{ needs.release-package.outputs.release-tag }} ${{ needs.generate-provenance.outputs.provenance-name }}
219219
env:
220220
GH_TOKEN: ${{ secrets.REPO_ACCESS_TOKEN }}
221221

222222
# Send out release notifications after the Release was published on GitHub.
223223
# Uncomment the `if` to disable sending release notifications.
224-
release-notifications:
224+
send-release-notifications:
225225
# if: ${{ false }}
226-
needs: [release]
226+
needs: [release-package]
227227
name: Send Release notifications
228228
uses: ./.github/workflows/_release-notifications.yaml
229229
permissions:
230230
contents: read
231231
with:
232232
repo-name: ${{ github.event.repository.name }}
233-
release-tag: ${{ needs.release.outputs.release-tag }}
234-
release-url: ${{ needs.release.outputs.release-url }}
233+
release-tag: ${{ needs.release-package.outputs.release-tag }}
234+
release-url: ${{ needs.release-package.outputs.release-url }}
235235
secrets:
236236
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
237237

238238
# Publish the generated Markdown documentation to the repository's Wiki.
239239
# Uncomment the `if` to disable generating Wiki documentation.
240-
release-wiki:
240+
publish-wiki:
241241
# if: ${{ false }}
242-
needs: [release]
242+
needs: [release-package]
243243
name: Publish Github Wiki documentation
244244
uses: ./.github/workflows/_wiki-documentation.yaml
245245
permissions:
246246
contents: read
247247
with:
248-
release-tag: ${{ needs.release.outputs.release-tag }}
249-
release-url: ${{ needs.release.outputs.release-url }}
248+
release-tag: ${{ needs.release-package.outputs.release-tag }}
249+
release-url: ${{ needs.release-package.outputs.release-url }}
250250
# Github disallows passing environment variables as arguments to a reusable
251251
# workflow, so we have to duplicate these values here. Related discussion
252252
# here: https://github.com/actions/toolkit/issues/931
@@ -259,9 +259,9 @@ jobs:
259259
# After the bump commit was pushed to the release branch, rebase the main branch
260260
# (to_head argument) on top of the new release branch (from_base argument), to keep
261261
# the histories of both branches in sync.
262-
release-rebase-main:
262+
rebase-main-branch:
263263
# if: ${{ false }}
264-
needs: [release]
264+
needs: [release-package]
265265
name: Rebase main branch on release
266266
uses: ./.github/workflows/_generate-rebase.yaml
267267
permissions:

0 commit comments

Comments
 (0)