chia7712 commented on code in PR #22475: URL: https://github.com/apache/kafka/pull/22475#discussion_r3371352940
########## .github/workflows/pr-reviewers-trailer-on-review.yml: ########## @@ -0,0 +1,77 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# When someone reviews a PR (even a plain Approve), credit them in the +# `Reviewers:` trailer. Reviewer comes from workflow_run.actor.login. +# +# Two things to know: +# - We trigger on `types: [requested]`, not `completed`. On a first-time +# contributor's fork PR the "Pull Request Reviewed" run is blocked pending +# approval and never completes; the `requested` event still fires the +# moment it is queued, so we act on that. +# - workflow_run doesn't carry the PR number for fork PRs, so we recover it +# by matching the run's head_sha against the open PRs via the API. + +name: Reviewers Trailer (on review) + +on: + workflow_run: + workflows: [Pull Request Reviewed] + types: + - requested + +run-name: Reviewers Trailer for ${{ github.event.workflow_run.display_title }} + +jobs: + append-trailer: + # Only react to review submissions. The "Pull Request Reviewed" workflow + # also runs on `pull_request` (open / edit), where the actor is the PR + # author rather than a reviewer. + if: | + github.event_name == 'workflow_run' && + github.event.workflow_run.event == 'pull_request_review' + runs-on: ubuntu-latest + permissions: + contents: read + pull-requests: write + steps: + - name: Env + run: printenv + env: + GITHUB_CONTEXT: ${{ toJson(github) }} + - name: Checkout code + uses: actions/checkout@v5 + with: + persist-credentials: false + - name: Append reviewer trailer + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + REPO: ${{ github.repository }} + HEAD_SHA: ${{ github.event.workflow_run.head_sha }} + REVIEWER_LOGIN: ${{ github.event.workflow_run.actor.login }} + run: | + set -e + # Match the run's head_sha against open PRs. Stream matches across + # all pages and take the first, rather than a per-page map(...).[0] + # which would emit a `null` per non-matching page under --paginate. + PR_NUMBER=$(gh api --paginate "repos/$REPO/pulls?state=open&per_page=100" \ Review Comment: Is `gh search` way better than using `gh api` to grab all PRs? ########## .github/workflows/pr-reviewers-trailer-on-comment.yml: ########## @@ -0,0 +1,57 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Credits a reviewer in the PR's `Reviewers:` trailer when they leave a +# top-level comment on the PR. This complements pr-reviewers-trailer-on-review +# (which handles the Review/Approve path). +# +# `issue_comment` is not subject to the first-time-contributor approval gate +# and always runs the workflow from the base repo's default branch, so fork +# code never executes here. + +name: Reviewers Trailer (on comment) + +on: + issue_comment: + types: [created] Review Comment: Please add comments for the trigger - when (and why) it will be triggered ########## .github/workflows/pr-reviewers-trailer-on-review.yml: ########## @@ -0,0 +1,77 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# When someone reviews a PR (even a plain Approve), credit them in the +# `Reviewers:` trailer. Reviewer comes from workflow_run.actor.login. +# +# Two things to know: +# - We trigger on `types: [requested]`, not `completed`. On a first-time +# contributor's fork PR the "Pull Request Reviewed" run is blocked pending +# approval and never completes; the `requested` event still fires the +# moment it is queued, so we act on that. +# - workflow_run doesn't carry the PR number for fork PRs, so we recover it +# by matching the run's head_sha against the open PRs via the API. + +name: Reviewers Trailer (on review) + +on: + workflow_run: Review Comment: Please add comments for the trigger - when (and why) it will be triggered ########## .github/workflows/pr-reviewers-trailer-on-review.yml: ########## @@ -0,0 +1,77 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# When someone reviews a PR (even a plain Approve), credit them in the +# `Reviewers:` trailer. Reviewer comes from workflow_run.actor.login. +# +# Two things to know: +# - We trigger on `types: [requested]`, not `completed`. On a first-time +# contributor's fork PR the "Pull Request Reviewed" run is blocked pending +# approval and never completes; the `requested` event still fires the +# moment it is queued, so we act on that. +# - workflow_run doesn't carry the PR number for fork PRs, so we recover it +# by matching the run's head_sha against the open PRs via the API. + +name: Reviewers Trailer (on review) + +on: + workflow_run: + workflows: [Pull Request Reviewed] + types: + - requested + +run-name: Reviewers Trailer for ${{ github.event.workflow_run.display_title }} + +jobs: + append-trailer: + # Only react to review submissions. The "Pull Request Reviewed" workflow + # also runs on `pull_request` (open / edit), where the actor is the PR + # author rather than a reviewer. + if: | + github.event_name == 'workflow_run' && + github.event.workflow_run.event == 'pull_request_review' + runs-on: ubuntu-latest + permissions: Review Comment: Could you move the `permissions` declaration to above the `jobs` section? It's more readable and consistent with `pr-reviewers-trailer-on-comment.yml` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
