Skip to content

Commit 5d5538d

Browse files
committed
Move trigger-scenario comment to file header
The comment describes the whole workflow's trigger behavior, not just determine-inputs, so it belongs at the top of the file alongside the manual re-trigger note.
1 parent 66db2f2 commit 5d5538d

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

.github/workflows/notify-consumers.yml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
name: Notify Consumers
22

3+
# workflow_run fires on EVERY completion of Main (any branch, any outcome),
4+
# so this workflow only actually runs for:
5+
# - a successful Main build on `main` (the commit-tagged image was just
6+
# published, e.g. a PR merged to main) -> triggered_by=merge, or
7+
# - a manual workflow_dispatch (re-trigger a stuck/skipped pin update)
8+
# -> triggered_by=manual
9+
# A failed Main run, or a successful run on a PR/feature branch, is
10+
# skipped: no image was published for consumers to pin to.
11+
312
# To manually re-trigger a consumer pin update, run:
413
# `gh workflow run "Notify Consumers" --ref main`
514

@@ -20,14 +29,6 @@ jobs:
2029
determine-inputs:
2130
name: "Determine trigger inputs"
2231
runs-on: ubuntu-24.04
23-
# workflow_run fires on EVERY completion of Main (any branch, any outcome),
24-
# so this job only actually runs for:
25-
# - a successful Main build on `main` (the commit-tagged image was just
26-
# published, e.g. a PR merged to main) -> triggered_by=merge, or
27-
# - a manual workflow_dispatch (re-trigger a stuck/skipped pin update)
28-
# -> triggered_by=manual
29-
# A failed Main run, or a successful run on a PR/feature branch, is
30-
# skipped: no image was published for consumers to pin to.
3132
if: >-
3233
github.event_name == 'workflow_dispatch' ||
3334
(github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.head_branch == 'main')
@@ -63,8 +64,7 @@ jobs:
6364
# get a cross-repo dd-octo-sts grant provisioned for images-rb to
6465
# dispatch into it, and make sure the consumer repo actually has a
6566
# workflow listening for the images-updated repository_dispatch
66-
# event. Until all of that exists, adding a matrix entry here will
67-
# just fail on every run.
67+
# event.
6868
- repo: DataDog/dd-trace-rb
6969
policy: images-rb.notify-dd-trace-rb
7070
steps:

0 commit comments

Comments
 (0)