Skip to content

Commit 33980bb

Browse files
committed
ci: name every job after what it does
The checks list on a PR was a wall of internal job ids. 'test (3.10)' says a job ran, not what it checked; 'publish_code' and 'tag_commit' are identifiers that were never meant to be read by a human deciding whether a PR is safe to merge. test -> run test suite on python 3.10 publish_code -> publish package and docker images tag_commit -> tag the release commit publish_docs -> publish the docs site test-distros -> install and smoke-test on fedora analyze -> scan python for security issues benchmark -> compare performance against the base branch cla -> check the CLA is signed update_docs -> regenerate the docs and open a PR update-nuclei-version -> open a PR when a new nuclei is released update-trufflehog-version -> open a PR when a new trufflehog is released Names only, no behavior change. Note this renames the status check contexts. The branch ruleset on dev still requires the old names, so it needs updating in the same window or required checks will sit pending forever.
1 parent cccc263 commit 33980bb

7 files changed

Lines changed: 11 additions & 1 deletion

File tree

.github/workflows/benchmark.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ permissions:
1717

1818
jobs:
1919
benchmark:
20+
name: compare performance against the base branch
2021
runs-on: ubuntu-latest
2122

2223
steps:

.github/workflows/cla.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,6 @@ permissions:
1111

1212
jobs:
1313
cla:
14+
name: check the CLA is signed
1415
uses: blacklanternsecurity/CLA/.github/workflows/cla-reusable.yml@main
1516
secrets: inherit

.github/workflows/codeql.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ on:
2121

2222
jobs:
2323
analyze:
24-
name: Analyze (${{ matrix.language }})
24+
name: scan ${{ matrix.language }} for security issues
2525
# Runner size impacts CodeQL analysis time. To learn more, please see:
2626
# - https://gh.io/recommended-hardware-resources-for-running-codeql
2727
# - https://gh.io/supported-runners-and-hardware-resources

.github/workflows/distro_tests.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ concurrency:
88

99
jobs:
1010
test-distros:
11+
name: install and smoke-test on ${{ matrix.os }}
1112
runs-on: ubuntu-latest
1213
container:
1314
image: ${{ matrix.os }}

.github/workflows/docs_updater.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ on:
77

88
jobs:
99
update_docs:
10+
name: regenerate the docs and open a PR
1011
runs-on: ubuntu-latest
1112
steps:
1213
- uses: actions/checkout@v7

.github/workflows/tests.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ concurrency:
1212

1313
jobs:
1414
test:
15+
name: run test suite on python ${{ matrix.python-version }}
1516
runs-on: ubuntu-latest
1617
strategy:
1718
# if one python version fails, let the others finish
@@ -52,6 +53,7 @@ jobs:
5253
files: ./cov.xml
5354
verbose: true
5455
publish_code:
56+
name: publish package and docker images
5557
needs: test
5658
runs-on: ubuntu-latest
5759
if: github.event_name == 'push' && (github.ref == 'refs/heads/dev' || github.ref == 'refs/heads/stable')
@@ -200,6 +202,7 @@ jobs:
200202
outputs:
201203
BBOT_VERSION: ${{ steps.version.outputs.BBOT_VERSION }}
202204
tag_commit:
205+
name: tag the release commit
203206
needs: publish_code
204207
runs-on: ubuntu-latest
205208
if: github.event_name == 'push' && (github.ref == 'refs/heads/stable' || github.ref == 'refs/heads/dev')
@@ -222,6 +225,7 @@ jobs:
222225
git push origin "$VERSION"
223226
224227
publish_docs:
228+
name: publish the docs site
225229
runs-on: ubuntu-latest
226230
if: github.event_name == 'push' && (github.ref == 'refs/heads/stable' || github.ref == 'refs/heads/dev')
227231
steps:

.github/workflows/version_updater.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ on:
77

88
jobs:
99
update-nuclei-version:
10+
name: open a PR when a new nuclei is released
1011
runs-on: ubuntu-latest
1112
steps:
1213
- uses: actions/checkout@v7
@@ -59,6 +60,7 @@ jobs:
5960
author: blsaccess <info@blacklanternsecurity.com>
6061
assignees: "TheTechromancer"
6162
update-trufflehog-version:
63+
name: open a PR when a new trufflehog is released
6264
runs-on: ubuntu-latest
6365
steps:
6466
- uses: actions/checkout@v7

0 commit comments

Comments
 (0)