Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Release Automation] Label PRs with GitHub Action #3151

Merged
merged 17 commits into from
Jun 7, 2023
Merged
Changes from 15 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 75 additions & 0 deletions .github/workflows/label-pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# Copyright 2023 Google LLC
#
# Licensed 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.
#
# This workflow utilizes https://github.com/actions/github-script in GitHub Actions to apply labels to pull requests.
#

name: Label PR

on:
pull_request:
types: [opened]

jobs:
label:
runs-on: ubuntu-latest
permissions:
pull-requests: write
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
permissions:
pull-requests: write
permissions:
contents: read
pull-requests: write

Possibly? Just taking reference from: https://github.com/actions/labeler#create-workflow

It's also possible to try it with the GITHUB_TOKEN

Copy link
Collaborator

@zmerlynn zmerlynn Jun 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or try permissions: read-all|write-all as mentioned in https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idpermissions, just to see if it's a permissions issue.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@markmandel, please merge this PR. I was able to reproduce the error in my fork by not adding the write permission to the pull_request and issues - https://github.com/Kalaiselvi84/agones/actions/runs/5185413754/jobs/9345294118?pr=274
You can adjust the permission in Agones if there is any issues. WDYT?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good! Merging!


gongmax marked this conversation as resolved.
Show resolved Hide resolved
steps:

- name: Label PR
uses: actions/github-script@v4
with:
async: yes
repo-token: ${{ secrets.AGONES_BOT }}
script: |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's super cool you can do this.

const keywords = {
"breaking": "kind/breaking",
"bug": "kind/bug",
"feature": "kind/feature",
"cleanup": "kind/cleanup",
"documentation": "kind/documentation",
"hotfix": "kind/hotfix"
};

const prBody = context.payload.pull_request.body;
const prLabels = [];

const regex = /^\s*\/kind\s+(.+)$/m;
const match = prBody.match(regex);

console.log(`PR body: '${prBody}'`);
console.log(`Regex match: '${match}'`);

if (match && match[1] in keywords) {
const keyword = match[1];
const label = keywords[keyword];
console.log(`Adding label: '${label}' based on keyword '${keyword}'`);
prLabels.push(label);
} else {
console.log(`Adding label: 'kind/other' as no matching keyword found.`);
prLabels.push("kind/other");
}

try {
await github.issues.addLabels({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.payload.pull_request.number,
labels: prLabels
});
} catch (error) {
console.error(`Error retrieving files: ${error}`);
}