Feature: updating release-note script to validate that all PRs have changelog label #4849
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
akagami-harsh
commented
Oct 16, 2023
akagami-harsh
commented
- [Feature]: (Re)Introduce changelog-related labels and require them for PRs #4799
- Alter the release notes script to validate that all PRs have changelog labels, fail if some don't and print their URLs so that the maintainer can fix them manually. This should ignore dependabot PRs automatically.
…labels Signed-off-by: Harshvir Potpose <[email protected]>
5 tasks
yurishkuro
reviewed
Oct 16, 2023
| changelog_prs = [] | ||
| other_prs = [] | ||
|
|
||
| for pr in repository.get_pulls(state='closed'): |
There was a problem hiding this comment.
this will load all historical PRs, but we only need those which are in the commit history since the last releast
There was a problem hiding this comment.
basically in L91 we already determine PRs
yurishkuro
reviewed
Oct 16, 2023
| if other_prs: | ||
| print('PRs without "changelog:" labels:') | ||
| for pr in other_prs: | ||
| print(f'{pr.title} - {pr.html_url}') |
There was a problem hiding this comment.
tip:
- trim title to fixed length like 50chars
- use whitespace padding so that URL column always starts from the same place
yurishkuro
reviewed
Oct 16, 2023
| @@ -16,6 +16,7 @@ | |||
| import urllib.parse | |||
| from os.path import expanduser | |||
| import sys | |||
| from github import Github | |||
There was a problem hiding this comment.
I think the nice feature of the existing script is that it runs without extra dependencies that need to be pip-installed
|
High-level comment: the idea in the ticket is not that the release script must validate PR labels, but that it uses those labels to automatically organize changelog entries into different sections |
|
#4850, did better than mine , closing this one |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.