Skip to content

Commit ab03186

Browse files
committed
Add comment re: Git ref to checkout step of "Manage PRs" workflow
Since it is intuitive and commonly used, the default behavior of the actions/checkout GitHub Actions action when a workflow is triggered the "pull_request" or "push" events is well understood by any workflow maintainer. However, the default behavior of the action when the workflow is triggered by a "pull_request_target" or "issue_comment" event (as is the case for the "Manage PRs" workflow) is not obvious and less well known since these events are more rarely used. It is important for the maintainer to understand which Git ref will be checked out by the actions/checkout action steps in the "Manage PRs" workflow. Adding an explanatory comment will help to ensure they have this understanding.
1 parent 9b475bf commit ab03186

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

.github/workflows/manage-prs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,8 @@ jobs:
133133
indexer-logs-urls: ${{ steps.parse-request.outputs.indexer-logs-urls }}
134134

135135
steps:
136+
# Checkout the tip of the default branch (this is the action's default ref input value when workflow is triggered
137+
# by an issue_comment or pull_request_target event).
136138
- name: Checkout local repository
137139
uses: actions/checkout@v4
138140

0 commit comments

Comments
 (0)