Skip to content

Changelog script: Add a general section to release notes for PRs without type labels#5565

Merged
fingolfin merged 2 commits intomasterfrom
ak96/changelogscript-todos-per-topic
Nov 26, 2025
Merged

Changelog script: Add a general section to release notes for PRs without type labels#5565
fingolfin merged 2 commits intomasterfrom
ak96/changelogscript-todos-per-topic

Conversation

@aaruni96
Copy link
Copy Markdown
Member

This introduces a section "General changes" for PRs without a type label. It also accounts for PRs without topic labels and without type labels. Fixes the issue @lgoettgens pointed out in #5544 (comment) .

General section looks like

Changes related to the package Singular

General changes

  • #5489 Update to Singular.jl 0.27

Leftover section looks like

TODO insufficient labels for automatic classification

The following PRs have neither a topic label assigned to them, nor a PR type.
Manual intervention required.

  • #5401 Tweak combination function

  • #5492 Temporary fix for saturation over quotient rings

@aaruni96 aaruni96 requested a review from lgoettgens November 19, 2025 12:34
@aaruni96 aaruni96 added the release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes label Nov 19, 2025
@aaruni96 aaruni96 changed the title Add a general section to release notes for PRs without type labels Chanlog script: Add a general section to release notes for PRs without type labels Nov 19, 2025
@lgoettgens lgoettgens changed the title Chanlog script: Add a general section to release notes for PRs without type labels Changelog script: Add a general section to release notes for PRs without type labels Nov 19, 2025
Comment thread dev/releases/release_notes.py Outdated
relnotes_file.write('\n')
# Items without a type label
if len(matches) > 0:
relnotes_file.write("#### General changes\n\n")
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.

How does this sort with other type sections?
I would envision it to be like this (with some more non-existent entries that I just came up with)

Changes to the package Singular

General changes

  • #5489 Update to Singular.jl 0.27

Optimizations

-#9999 Improve conversion from/to Singular types

If that is the case (i.e. the general changes are always the first type section inside a topic), I would say we can even drop the header, i.e.

Suggested change
relnotes_file.write("#### General changes\n\n")

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Right now, the "general changes" is always the last section. (In the logic, the list is "whatever is left over after we have sorted things into sections.")

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.

@fingolfin do you have an opinion on this?

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.

It depends a bit on how we use this.

In the context of packages, it is conceivable that often this is the only section anyway; and then having it first without a title makes sense.

But as soon as there are or sections, it feels weird to put the "left overs" at the start.

My preferred solution thus would be:

  • if there is no other subsection (so it is both at the start and the end, if you will) then omit the title
  • otherwise put it at the end but call the section "Other changes" or "Miscellaneous change" to emphasize these were stuff that did not fit into any other category.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Done, I think

Copy link
Copy Markdown
Member

@fingolfin fingolfin left a comment

Choose a reason for hiding this comment

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

Looks good to me. Let's merge it and try it ;-)

@fingolfin fingolfin merged commit b87e88e into master Nov 26, 2025
1 check passed
@fingolfin fingolfin deleted the ak96/changelogscript-todos-per-topic branch November 26, 2025 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes triage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants