Auto label PRs #1518

SachinSahu431 · 2024-05-19T15:25:42Z

Describe your PR

This PR introduces automation for labelling PRs based on their content, aiming to streamline our changelog generation process. For more details, please refer to the changelog automation proposal document.

With this automation, PRs will be tagged automatically with relevant labels like kind/bug ,kind/feature, or release-note-none, facilitating accurate and consistent changelog entries.

What type of PR is this?

/kind fix

Changelog Entry

NONE

I think it's a bit our fault (Kemal and I), but your proposal wasn't shared with the community for evaluation. We could've reminded you to share it more often... but better late than never! What do you think of including your proposal in the PR description to make sure other can understand what you're trying to accomplish here and raise concerns/opinions if they have any?

.github/labeler.yml

.github/workflows/pr-auto-label.yml

.github/labeler.yml

Signed-off-by: Sachin Sahu <[email protected]>

SachinSahu431 · 2024-05-21T12:04:54Z

Thanks for the review, @ArthurSens! ❤️

I've included the proposal document in the PR description and left comments where I encountered difficulties.

Signed-off-by: Sachin Sahu <[email protected]>

* Update CONTRIBUTING.md and PR template * Add examples in PR template --------- Signed-off-by: Sachin Sahu <[email protected]>

Signed-off-by: Sachin Sahu <[email protected]>

ArthurSens

Comments from our pair review today

.github/labeler.yml

.github/pull-request-template.md

.github/workflows/pr-auto-label.yml

Signed-off-by: Sachin Sahu <[email protected]>

SachinSahu431 · 2024-05-26T18:36:39Z

For PRs to be labelled correctly, it is important that the contributor fills the PR template properly. He gets notified if template has missing components:

Example PR showing this functionality: SachinSahu431#56

ArthurSens

Awesome job making it work like this, but let's keep things simple if we can 🙂

ArthurSens · 2024-05-27T14:07:27Z

.github/workflows/pr-auto-label.yml

+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Fetch PR Body
+        id: fetch_body
+        run: |
+          body=$(curl -sSL -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" https://api.github.com/repos/${{ github.repository }}/pulls/${{ github.event.number }} | jq -r '.body')
+          echo "BODY<<EOF" >> $GITHUB_ENV
+          echo "$body" >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+      - name: Check for labels in PR body
+        run: |
+          if [[ $(cat <<EOF 
+          ${{ env.BODY }} 
+          EOF) =~ /kind\ (fix|bugfix|feat|feature|enhancement|change|none|NONE|release-note-none|release-notes-none) ]] ; then
+            echo "PR body contains a valid type of change"
+          else
+            echo "PR body does not contain a valid type of change. Please refer to CONTRIBUTING.md for more information."
+            curl -sSL -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+              -X POST https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.number }}/comments \
+              -d '{"body": "PR body does not contain a valid type of change. Please refer to [CONTRIBUTING.md](https://github.com/prometheus/client_golang/blob/main/CONTRIBUTING.md#how-to-fill-the-pr-template) for more information."}'
+            exit 0
+          fi


Oh wow, I'm impressed that you made this work like this :O

But I'm not sure if we need to maintain something complex like this, GitHub Actions provide good support for triggering conditional steps.

Maybe we could simplify this a little bit?

What immediately comes to mind is:

continue-on-error for the labeler step

Another github-action that is capable of commenting on PRs, and a conditional on this step that will only execute if the previous one failed

The labeler action we are currently using never fails; it always reports success, even if no labels are added. This makes it unsuitable for conditional steps.

I searched for alternative labeler actions that return a failure status but none offer the same level of regex configuration as our current one.

Since labeler action can't detect the absence of labels, I had to use GitHub API to fetch the PR description and post a comment 🙂

@ArthurSens Thanks for recommending this GitHub Action! Our workflow is much cleaner now :)

A comment is added if a label is missing, and it is automatically deleted when the label is added.

Signed-off-by: Sachin Sahu <[email protected]>

Signed-off-by: Kemal Akkoyun <[email protected]>

.github/workflows/pr-auto-label.yml

Co-authored-by: Arthur Silva Sens <[email protected]> Signed-off-by: Sachin Sahu <[email protected]>

Fix: Auto label PRs #1518

chore: Automatically add labels to PRs, based on description Co-authored-by: Arthur Silva Sens <[email protected]> Signed-off-by: Sachin Sahu <[email protected]> --------- Signed-off-by: Sachin Sahu <[email protected]> Signed-off-by: Sachin Sahu <[email protected]> Signed-off-by: Kemal Akkoyun <[email protected]> Co-authored-by: Kemal Akkoyun <[email protected]> Co-authored-by: Arthur Silva Sens <[email protected]> Signed-off-by: Steven Swartz <[email protected]>

SachinSahu431 added 2 commits May 19, 2024 15:11

Update CONTRIBUTING.md and PR template

334f0f7

Signed-off-by: Sachin Sahu <[email protected]>

Add workflow to auto label PRs

bde1c78

Signed-off-by: Sachin Sahu <[email protected]>

SachinSahu431 mentioned this pull request May 19, 2024

Changelog generation workflow #1519

Closed

Revert duplicate changes

98e0b58

Signed-off-by: Sachin Sahu <[email protected]>

ArthurSens reviewed May 21, 2024

View reviewed changes

Update label config

9675ca7

Signed-off-by: Sachin Sahu <[email protected]>

SachinSahu431 added 4 commits May 22, 2024 08:33

Enhance regex to handle PR template

3720378

Signed-off-by: Sachin Sahu <[email protected]>

PR template (#42)

70d38e2

* Update CONTRIBUTING.md and PR template * Add examples in PR template --------- Signed-off-by: Sachin Sahu <[email protected]>

Merge branch 'main' into sachin/auto-label-pr

5b8d370

Signed-off-by: Sachin Sahu <[email protected]>

Test pull_request

33aa5ba

Signed-off-by: Sachin Sahu <[email protected]>

ArthurSens reviewed May 23, 2024

View reviewed changes

.github/labeler.yml Outdated Show resolved Hide resolved

.github/pull-request-template.md Outdated Show resolved Hide resolved

.github/workflows/pr-auto-label.yml Outdated Show resolved Hide resolved

SachinSahu431 added 3 commits May 26, 2024 10:55

Remove duplicate files

79812ee

Signed-off-by: Sachin Sahu <[email protected]>

Add 'CHANGE' kind

9a8e344

Signed-off-by: Sachin Sahu <[email protected]>

Add comment if labeler workflow fails

269fb49

Signed-off-by: Sachin Sahu <[email protected]>

SachinSahu431 requested a review from ArthurSens May 26, 2024 18:38

ArthurSens reviewed May 27, 2024

View reviewed changes

SachinSahu431 and others added 2 commits May 29, 2024 15:10

Modify PR-label validation workflow

be7ef75

Signed-off-by: Sachin Sahu <[email protected]>

Merge branch 'main' into sachin/auto-label-pr

e413851

Signed-off-by: Kemal Akkoyun <[email protected]>

ArthurSens reviewed May 30, 2024

View reviewed changes

.github/workflows/pr-auto-label.yml Outdated Show resolved Hide resolved

Update .github/workflows/pr-auto-label.yml

68c54a6

Co-authored-by: Arthur Silva Sens <[email protected]> Signed-off-by: Sachin Sahu <[email protected]>

ArthurSens enabled auto-merge (squash) May 30, 2024 13:47

ArthurSens merged commit 105a3b7 into prometheus:main May 30, 2024
9 checks passed

SachinSahu431 mentioned this pull request May 31, 2024

Fix: Auto label PRs #1518 #1525

Merged

ArthurSens pushed a commit that referenced this pull request May 31, 2024

Merge pull request #1525 from SachinSahu431/sachin/update-pr-labeler

4b158ab

Fix: Auto label PRs #1518

renovate bot mentioned this pull request Aug 20, 2024

fix(deps): update all dependencies concourse/concourse#8985

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Auto label PRs #1518

Auto label PRs #1518

SachinSahu431 commented May 19, 2024 •

edited

Loading

ArthurSens left a comment

SachinSahu431 commented May 21, 2024

ArthurSens left a comment

SachinSahu431 commented May 26, 2024 •

edited

Loading

ArthurSens left a comment

ArthurSens May 27, 2024

ArthurSens May 27, 2024 •

edited

Loading

SachinSahu431 May 28, 2024

SachinSahu431 May 29, 2024

Auto label PRs #1518

Auto label PRs #1518

Conversation

SachinSahu431 commented May 19, 2024 • edited Loading

Describe your PR

What type of PR is this?

Changelog Entry

Related:

ArthurSens left a comment

Choose a reason for hiding this comment

SachinSahu431 commented May 21, 2024

ArthurSens left a comment

Choose a reason for hiding this comment

SachinSahu431 commented May 26, 2024 • edited Loading

ArthurSens left a comment

Choose a reason for hiding this comment

ArthurSens May 27, 2024

Choose a reason for hiding this comment

ArthurSens May 27, 2024 • edited Loading

Choose a reason for hiding this comment

SachinSahu431 May 28, 2024

Choose a reason for hiding this comment

SachinSahu431 May 29, 2024

Choose a reason for hiding this comment

SachinSahu431 commented May 19, 2024 •

edited

Loading

SachinSahu431 commented May 26, 2024 •

edited

Loading

ArthurSens May 27, 2024 •

edited

Loading