Skip to content

Release notes: 2 level of changelog#5271

Merged
fingolfin merged 5 commits intooscar-system:masterfrom
aaruni96:ak96/multi-level-changelog
Sep 12, 2025
Merged

Release notes: 2 level of changelog#5271
fingolfin merged 5 commits intooscar-system:masterfrom
aaruni96:ak96/multi-level-changelog

Conversation

@aaruni96
Copy link
Copy Markdown
Member

@aaruni96 aaruni96 commented Sep 5, 2025

Fixes #4665


Note: I am also using this PR body as my testing ground for my solution to #4673 . Everything in this comment after this line can be ignored for any other use.


Release Notes

  • Does abc {package: AbstractAlgebra, renaming}
  • Does 123 {package: Nemo, documentation}
  • Questions 42 {package: Singular, serialization}

@aaruni96
Copy link
Copy Markdown
Member Author

aaruni96 commented Sep 5, 2025

PRs like #5065 and #5186 only have one label for topic, and no secondary label. The script in its current form does not deal with this, and these PRs are excluded from the changelog.

Two options for dealing with this :

  • introduce a "general" subsection where we put such PRs
  • enforce all PRs to have at least two labels, one for the main section, one for the subsection

Which one do we want? Or do we want to do both ?

@aaruni96 aaruni96 added release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes Decision labels Sep 5, 2025
@aaruni96 aaruni96 added the release notes: use body For PRs: the release notes string is included in the body text of the PR label Sep 5, 2025
@fingolfin
Copy link
Copy Markdown
Member

Aaruni and me discussed this last week, and my stance was "I don't care if we automatically put things into a "general" subsection or enforce two labels, as long as we don't "loose" PRs due to insufficient labels". My understanding is that this now got implemented by essentially enforcing "two labels" (i.e. a primary and a secondary label), and anything that doesn't have both will be flagged ?

@fingolfin
Copy link
Copy Markdown
Member

Regarding progress on #4673: very nice! Though it's still missing support for specifying "additional labels" in the text.

@aaruni96
Copy link
Copy Markdown
Member Author

aaruni96 commented Sep 8, 2025

and anything that doesn't have both will be flagged ?

Yes. The current implementation dumps things without two labels at the end, marked with a "TODO". Then manual work is required, either to re-label the PRs and re-run the script, or, to move things into a "general" category by hand.

@aaruni96 aaruni96 force-pushed the ak96/multi-level-changelog branch from ba36c39 to 2c9d6f6 Compare September 8, 2025 20:55
Comment thread dev/releases/release_notes.py
]
prtypes = [
["renaming", "Renamings"],
["serialization", "Changes related to serializing data in the MRDI file format"],
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.

Why is that a "prtype" and not a "topic"?

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.

In PR like #5246 , you have both serialization and topic: polyhedral geometry. So, in the multilevel changelog would put it under "Polyhedral geometry", and the subheading "serialization".

If we put serialization in topics, then one of these labels will be ignored (script puts a PR in the first topic which is matched)

@aaruni96 aaruni96 removed the Decision label Sep 10, 2025
Comment thread dev/releases/release_notes.py Outdated
@fingolfin fingolfin enabled auto-merge (squash) September 10, 2025 14:10
@fingolfin fingolfin disabled auto-merge September 10, 2025 14:13
@fingolfin
Copy link
Copy Markdown
Member

This is ready from my POV. I'd merge it, if not for the upcoming 1.5 release -- @lgoettgens @benlorenz would you prefer we wait this after the merge (just in case it breaks something), or should we merge now?

@lgoettgens
Copy link
Copy Markdown
Member

I would prefer to wait until after the release, as I already checked the manual work needed for the release notes with the current setup. And I don't know how much changes with this change

side point: this PR has conflicting labels

@benlorenz
Copy link
Copy Markdown
Member

I would also prefer to wait until after the release.

@lgoettgens
Copy link
Copy Markdown
Member

The changes from this PR should also be reflected in the respective docs at https://docs.oscar-system.org/dev/DeveloperDocumentation/changelog/.

@fingolfin fingolfin merged commit a941003 into oscar-system:master Sep 12, 2025
30 of 31 checks passed
@aaruni96 aaruni96 deleted the ak96/multi-level-changelog branch April 23, 2026 23:03
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 release notes: use body For PRs: the release notes string is included in the body text of the PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Release notes script: produce two levels of notes

4 participants