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

GH-499: Require PR labels for changelog #594

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

lidavidm
Copy link
Member

@lidavidm lidavidm commented Feb 7, 2025

  • 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.

@jbonofre
Copy link
Member

jbonofre commented Feb 7, 2025

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

@lidavidm
Copy link
Member Author

lidavidm commented Feb 8, 2025

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
Copy link
Member

jbonofre commented Feb 8, 2025

Yes. It's what I have in mind.

@lidavidm
Copy link
Member Author

.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
@lidavidm
Copy link
Member Author

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
Copy link
Member

@kou kou left a comment

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!

.github/workflows/dev_pr.yml Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
lidavidm and others added 3 commits February 13, 2025 00:58
Co-authored-by: Sutou Kouhei <[email protected]>
Co-authored-by: Sutou Kouhei <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Release] How to create release note?
3 participants