Skip to content

Commit f58cb3d

Browse files
committed
Improve comment for concurrency settings
1 parent 51975ff commit f58cb3d

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

pr-checks/sync.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -309,8 +309,14 @@ def writeHeader(checkStream):
309309
# For other events, the new workflows should wait until earlier ones have finished.
310310
# This should help reduce the number of concurrent workflows on the repo, and
311311
# consequently the number of concurrent API requests.
312+
# Note, the `|| false` is intentional to rule out that this somehow ends up being
313+
# `true` since we observed workflows for non-`pull_request` events getting cancelled.
312314
'cancel-in-progress': "${{ github.event_name == 'pull_request' || false }}",
313-
# The group is determined by the workflow name + the ref
315+
# The group is determined by the workflow name, the ref, and the input values.
316+
# The base name is hard-coded to avoid issues when the workflow is triggered by
317+
# a `workflow_call` event (where `github.workflow` would be the name of the caller).
318+
# The input values are added, since they may result in different behaviour for a
319+
# given workflow on the same ref.
314320
'group': checkName + "-${{github.ref}}" + extraGroupName
315321
},
316322
'jobs': {

0 commit comments

Comments
 (0)