Prioritize "bug" label for changelog sections#16433
Merged
dhruvmanila merged 1 commit intomainfrom Feb 28, 2025
Merged
Conversation
dhruvmanila
commented
Feb 28, 2025
Comment on lines
120
to
124
| changelog_sections.fixes = "Rule changes" | ||
| changelog_sections.formatter = "Formatter" | ||
| changelog_sections.isort = "Rule changes" | ||
| changelog_sections.performance = "Performance" | ||
| changelog_sections.formatter = "Formatter" | ||
| changelog_sections.server = "Server" |
Member
Author
There was a problem hiding this comment.
This change is just to group the "Rule changes" section
MichaReiser
reviewed
Feb 28, 2025
|
|
||
| changelog_sections.breaking = "Breaking changes" | ||
| changelog_sections.preview = "Preview features" | ||
| changelog_sections.bug = "Bug fixes" |
Member
There was a problem hiding this comment.
Do I understand this correctly that an issue labeled with both bug and preview would still be categorized as preview (which I think is the correct behavior)
Site note: Sort of funny that we rely on the ordering of elements in a TOML table -- which is not specified.
Member
Author
There was a problem hiding this comment.
Yes, that's correct.
Member
Author
|
(I cancelled the build workflow as the changes are not going to affect them.) |
dcreager
added a commit
that referenced
this pull request
Feb 28, 2025
* main: [red-knot] Switch to a handwritten parser for mdtest error assertions (#16422) [red-knot] Disallow more invalid type expressions (#16427) Bump version to Ruff 0.9.9 (#16434) Check `LinterSettings::preview` for version-related syntax errors (#16429) Avoid caching files with unsupported syntax errors (#16425) Prioritize "bug" label for changelog sections (#16433) [`flake8-copyright`] Add links to applicable options (`CPY001`) (#16421) Fix string-length limit in documentation for PYI054 (#16432) Show version-related syntax errors in the playground (#16419) Allow passing `ParseOptions` to inline tests (#16357) Bump version to 0.9.8 (#16414) [red-knot] Ignore surrounding whitespace when looking for `<!-- snapshot-diagnostics -->` directives in mdtests (#16380) Notify users for invalid client settings (#16361) Avoid indexing the project if `configurationPreference` is `editorOnly` (#16381)
dcreager
added a commit
that referenced
this pull request
Feb 28, 2025
* dcreager/alist-type: Remove unneeded shear override Update property test CI Move alist into red_knot_python_semantic [red-knot] Switch to a handwritten parser for mdtest error assertions (#16422) [red-knot] Disallow more invalid type expressions (#16427) Bump version to Ruff 0.9.9 (#16434) Check `LinterSettings::preview` for version-related syntax errors (#16429) Avoid caching files with unsupported syntax errors (#16425) Prioritize "bug" label for changelog sections (#16433) [`flake8-copyright`] Add links to applicable options (`CPY001`) (#16421) Fix string-length limit in documentation for PYI054 (#16432) Show version-related syntax errors in the playground (#16419) Allow passing `ParseOptions` to inline tests (#16357) Bump version to 0.9.8 (#16414) [red-knot] Ignore surrounding whitespace when looking for `<!-- snapshot-diagnostics -->` directives in mdtests (#16380) Notify users for invalid client settings (#16361) Avoid indexing the project if `configurationPreference` is `editorOnly` (#16381)
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
This PR updates the ordering of changelog sections to prioritize
buglabel such that any PRs that has that label is categorized in "Bug fixes" section in when generating the changelog irrespective of any other labels present on the PR.I think this works because I've seen PRs with both
serverandbugin the "Server" section instead of the "Bug fixes" section. For example, #16262 in https://github.com/astral-sh/ruff/releases/tag/0.9.7.On that note, this also changes the ordering such that any PR with both
serverandbuglabels are in the "Bug fixes" section instead of the "Server" section. This is in line with how "Formatter" is done. I think it makes sense to instead prefix the entries with "Formatter:" and "Server:" if they're bug fixes. But, I'm happy to change this such that any PRs withformatterandserverlabels are always in their own section irrespective of other labels.