Skip to content

GH-499: Require PR labels for changelog - #594

Merged
lidavidm merged 9 commits into
apache:mainfrom
lidavidm:gh-499
Feb 18, 2025
Merged

GH-499: Require PR labels for changelog#594
lidavidm merged 9 commits into
apache:mainfrom
lidavidm:gh-499

Conversation

@lidavidm

@lidavidmlidavidm commented Feb 7, 2025•
edited
Loading

Copy link
Copy Markdown
Member
  • Validate that at least one of certain labels are present on a PR.
  • Validate the format of the title.
  • Add label for things that are not dependencies but are other chores (release/build work).
  • Add label for documentation updates.
  • Validate that a PR titled GH-499 is actually linked to issue #499 by poking the GitHub API.
  • Add the GitHub config to use these labels for changelog generation.

Closes#499.

@lidavidmlidavidm mentioned this pull request Feb 7, 2025
Closed
@jbonofre
jbonofre self-requested a review February 7, 2025 15:37
@jbonofre

jbonofre commented Feb 7, 2025

Copy link
Copy Markdown
Member

It looks good. Maybe we should also update the GitHub PR Template to "strongly" emphasize on issue ?

@lidavidm

lidavidm commented Feb 8, 2025

Copy link
Copy Markdown
MemberAuthor

Will do.

It looks like you can't have selectors in pull request templates like you can in issues, but looks like we could add a set of checkboxes and have the action populate the labels based on that instead (or something similar)

@jbonofre

jbonofre commented Feb 8, 2025

Copy link
Copy Markdown
Member

Yes. It's what I have in mind.

@lidavidm

lidavidm commented Feb 10, 2025

Copy link
Copy Markdown
MemberAuthor

Example run: https://github.com/lidavidm/arrow-java/actions/runs/13234776842/job/36937648586

kou
kou reviewed Feb 10, 2025
View reviewed changes
Comment thread.github/pull_request_template.md Outdated
Comment thread.github/pull_request_template.md Outdated
Comment thread.github/pull_request_template.md Outdated
Comment thread.github/pull_request_template.md Outdated
Comment thread.github/pull_request_template.md Outdated
@lidavidm

lidavidm commented Feb 13, 2025

Copy link
Copy Markdown
MemberAuthor

I've updated this with an action that checks the title, linked issue, and labels.

Demo here: lidavidm#6

If missing a label it will make a comment, when the label is added it will hide the comment.

@lidavidm
lidavidm marked this pull request as ready for review February 13, 2025 04:32
kou
kou approved these changes Feb 13, 2025
View reviewed changes

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

+1

Let's try this!

Comment thread.github/workflows/dev_pr.yml Outdated
Comment threadCONTRIBUTING.md Outdated
Comment threadCONTRIBUTING.md Outdated
lidavidmand others added 3 commits February 13, 2025 00:58
@lidavidm@kou
Update .github/workflows/dev_pr.yml
d4075c1
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@lidavidm@kou
Update CONTRIBUTING.md
ac75e64
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@lidavidm@kou
Update CONTRIBUTING.md
e46f293
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@lidavidm
lidavidm merged commit 52cf1f2 into apache:mainFeb 18, 2025
@lidavidmlidavidm added this to the 18.3.0 milestone Feb 18, 2025
@lidavidmlidavidm added the enhancement PRs that add or improve features. label Feb 18, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@koukoukou approved these changes
@jbonofrejbonofreAwaiting requested review from jbonofrejbonofre is a code owner
@laurentgolaurentgoAwaiting requested review from laurentgolaurentgo is a code owner
@wgtmacwgtmacAwaiting requested review from wgtmacwgtmac is a code owner

Assignees

No one assigned

Labels

enhancementPRs that add or improve features.

Projects

None yet

Milestone

18.3.0

Development

Successfully merging this pull request may close these issues.

[Release] How to create release note?

3 participants

@lidavidm@jbonofre@kou