Copilot commented on code in PR #720: URL: https://github.com/apache/sedona-db/pull/720#discussion_r2944870852
########## .github/workflows/assign-reviewer.yml: ########## @@ -0,0 +1,44 @@ +# 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. + +# Captures PR metadata for the reviewer assignment workflow. +# The actual assignment is performed by assign-reviewer-write.yml +# (workflow_run trigger) which has write permission. +# See https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=321719166 + +name: "Compute Reviewer Assignment" +on: + pull_request: + types: [opened] + +jobs: + compute: + permissions: + contents: read + runs-on: ubuntu-latest + steps: + - uses: actions/github-script@v7 + with: + script: | + const fs = require('fs'); + fs.mkdirSync('pr-meta'); + fs.writeFileSync('pr-meta/number.txt', String(context.issue.number)); + fs.writeFileSync('pr-meta/author.txt', context.payload.pull_request.user.login); + - uses: actions/upload-artifact@v4 + with: + name: pr-meta + path: pr-meta/ Review Comment: The PR metadata artifact will use the default retention period, which is typically much longer than needed for a short-lived `workflow_run` handoff. Consider setting a small `retention-days` (e.g., 1–7) to reduce artifact storage and clutter. ########## .github/workflows/assign-reviewer-write.yml: ########## @@ -0,0 +1,111 @@ +# 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. + +# Reads PR metadata from the artifact produced by assign-reviewer.yml, +# loads the reviewer list from the trusted main branch, computes the +# round-robin assignment, and requests a review. +# See https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=321719166 + +name: "Assign Reviewer to PR" +on: + workflow_run: + workflows: ["Compute Reviewer Assignment"] + types: + - completed + +jobs: + assign: + permissions: + contents: read + pull-requests: write + runs-on: ubuntu-latest + if: > + github.event.workflow_run.event == 'pull_request' && + github.event.workflow_run.conclusion == 'success' + steps: + - name: Checkout reviewers config + uses: actions/checkout@v4 + with: + repository: apache/sedona-db Review Comment: `repository: apache/sedona-db` hard-codes the repo name for the trusted checkout. This will break if the repo is renamed or if the workflow is run in a fork; consider using `${{ github.repository }}` (and still pinning `ref: main`) to keep the workflow self-contained and maintainable. ########## .github/workflows/assign-reviewer-write.yml: ########## @@ -0,0 +1,111 @@ +# 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. + +# Reads PR metadata from the artifact produced by assign-reviewer.yml, +# loads the reviewer list from the trusted main branch, computes the +# round-robin assignment, and requests a review. +# See https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=321719166 + +name: "Assign Reviewer to PR" +on: + workflow_run: + workflows: ["Compute Reviewer Assignment"] + types: + - completed + +jobs: + assign: + permissions: + contents: read + pull-requests: write + runs-on: ubuntu-latest + if: > + github.event.workflow_run.event == 'pull_request' && + github.event.workflow_run.conclusion == 'success' + steps: + - name: Checkout reviewers config + uses: actions/checkout@v4 + with: + repository: apache/sedona-db + ref: main + path: config + sparse-checkout: .github/reviewers.json + sparse-checkout-cone-mode: false + persist-credentials: false + + - name: Download PR metadata artifact + uses: actions/github-script@v7 + with: + script: | + const artifacts = await github.rest.actions.listWorkflowRunArtifacts({ + owner: context.repo.owner, + repo: context.repo.repo, + run_id: ${{ github.event.workflow_run.id }}, + }); + const match = artifacts.data.artifacts.find(a => a.name === 'pr-meta'); + if (!match) { + core.setFailed('No pr-meta artifact found'); + return; + } + const download = await github.rest.actions.downloadArtifact({ + owner: context.repo.owner, + repo: context.repo.repo, + artifact_id: match.id, + archive_format: 'zip', + }); + const fs = require('fs'); + fs.writeFileSync('${{ github.workspace }}/pr-meta.zip', Buffer.from(download.data)); + + - name: Unzip artifact + run: unzip -d pr-meta pr-meta.zip + + - name: Assign reviewer + uses: actions/github-script@v7 + with: + script: | + const fs = require('fs'); + + // Read reviewer list from trusted checkout (main branch) + const reviewers = JSON.parse(fs.readFileSync('config/.github/reviewers.json', 'utf8')); + + // Read PR metadata from artifact (untrusted - validate before use) + const prNumber = parseInt(fs.readFileSync('pr-meta/number.txt', 'utf8').trim(), 10); + const author = fs.readFileSync('pr-meta/author.txt', 'utf8').trim(); + + if (isNaN(prNumber) || prNumber <= 0) { + throw new Error(`Invalid PR number: ${prNumber}`); + } + if (!/^[a-zA-Z0-9_-]+$/.test(author)) { + throw new Error(`Invalid author: ${author}`); + } + + const eligible = reviewers.filter(r => r !== author); + if (eligible.length === 0) { + console.log('No eligible reviewers, skipping'); + return; + } + + const idx = prNumber % eligible.length; Review Comment: The round-robin index is off by one: using `prNumber % eligible.length` will select `eligible[1]` for PR #1 (skipping the first reviewer). If the intent is to start with the first reviewer for PR #1, compute the index from a 0-based PR sequence (e.g., `prNumber - 1`). -- 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]
