Skip to content

Update changelog#5544

Merged
benlorenz merged 1 commit intomasterfrom
update-changelog
Nov 28, 2025
Merged

Update changelog#5544
benlorenz merged 1 commit intomasterfrom
update-changelog

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Automated changes by create-pull-request GitHub action

@lgoettgens lgoettgens marked this pull request as draft November 12, 2025 11:17
Comment thread CHANGELOG.md Outdated
Comment thread CHANGELOG.md
Comment on lines +66 to +72
### Tropical Geometry

### Changes related to the package GAP

### Changes related to the package Hecke

### Changes related to the package Singular
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 are there empty headers here without any content?

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.

This happens when a PR was tagged with a topic label, but not with a type label. The script finds non zero number of things under tropical geometry, so generates a heading for it. But it never finds a type label, so, neither the secondary heading, nor the PR itself is printed here. They end up in the TODO section. IMO, leaving it like this might be fine, so, we know where to (manually) insert something.

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.

I'd say it's better then to move these things with "missing labels into the right topic section, but in subsection #### TODO: missing type label or so

Comment thread CHANGELOG.md Outdated

- [#5267](https://github.com/oscar-system/Oscar.jl/pull/5267) Add `order_bound` keyword argument to `subgroup_classes`
- [#5284](https://github.com/oscar-system/Oscar.jl/pull/5284) Implement chamber counting algorithm for toric line bundles
- [#5288](https://github.com/oscar-system/Oscar.jl/pull/5288) Add `p_rump` for `GAPGroup` and extend `torsion_subgroup` for `GAPGroup` and `WeylGroup`
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.

This has a "topic: groups" label, but is not sorted into the appropriate section above

Copy link
Copy Markdown
Member

@aaruni96 aaruni96 Nov 12, 2025

Choose a reason for hiding this comment

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

This should be fixed whenever #5279 is merged


Maybe it was unwise to add patches for this into that PR, from a keeping PRs on topic point of view, but its currently probably the fastest way of patching this.

@joschmitt
Copy link
Copy Markdown
Member

Looking at some of the entries in the "TODO" categories, I realize that I don't know how many or what labels a pull request needs to make the script happy.
My impression is:

  1. A release notes: ... label
  2. A topic: ... label
  3. Some other label like enhancement but I don't know what exactly falls into this category.

Is this correct? Is it written down somewhere? I so far I followed the two-label-approach from https://docs.oscar-system.org/stable/DeveloperDocumentation/changelog/ but apparently that's not enough anymore?

@lgoettgens
Copy link
Copy Markdown
Member

Looking at some of the entries in the "TODO" categories, I realize that I don't know how many or what labels a pull request needs to make the script happy. My impression is:

  1. A release notes: ... label
  2. A topic: ... label
  3. Some other label like enhancement but I don't know what exactly falls into this category.

Is this correct? Is it written down somewhere? I so far I followed the two-label-approach from https://docs.oscar-system.org/stable/DeveloperDocumentation/changelog/ but apparently that's not enough anymore?

As I noted in #5544 (comment), there is currently some issue with how these things are put into categories. I would assume that this also affects your examples

@aaruni96
Copy link
Copy Markdown
Member

aaruni96 commented Nov 12, 2025

apparently that's not enough anymore?

Your impression should be correct. Can you look at the new changelog ( 06019bf ), and if there is still unexpected behaviour, point out the exact PRs which are miscategorised ?

Some other label like enhancement but I don't know what exactly falls into this category.

The two kinds of labels (topics, and types) have been expanded upon, but this is still in the dev docs, not yet in stable.

https://docs.oscar-system.org/dev/DeveloperDocumentation/changelog/#Multi-level-topics

Comment thread CHANGELOG.md Outdated

### **TODO** insufficient labels for automatic classification

The following PRs only have a topic label assigned to them, not a PR type. Either assign a type label to them (e.g., `enhancement`), or manually move them to the general section of the topic section in the changelog.
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.

Can you instead put the into their respective general section, but with a todo note each? I think it is easier to just manually remove todo notes than moving things around in this file.
I am asking because I see a bunch of things here, that don't fit into any subsection, e.g. updates of dependencies

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.

Day's event have started. I shall look at it again today at night.

@joschmitt
Copy link
Copy Markdown
Member

apparently that's not enough anymore?

Your impression should be correct. Can you look at the new changelog ( 06019bf ), and if there is still unexpected behaviour, point out the exact PRs which are miscategorised ?

Some other label like enhancement but I don't know what exactly falls into this category.

The two kinds of labels (topics, and types) have been expanded upon, but this is still in the dev docs, not yet in stable.

https://docs.oscar-system.org/dev/DeveloperDocumentation/changelog/#Multi-level-topics

Okay, sorry, I did not look at the most recent documentation. So the gist is that every pull request now needs three labels? And wouldn't it be good to have all the "type" labels start with "type:" and possibly all have the same colour?

@fingolfin
Copy link
Copy Markdown
Member

Okay, sorry, I did not look at the most recent documentation. So the gist is that every pull request now needs three labels?

Yes that's how it has been since we introduced this system. (Well, you can get away with one label if it is release notes: not needed ;-) but in general: three)

And wouldn't it be good to have all the "type" labels start with "type:" and possibly all have the same colour?

I don't want this for the colors: both "bug" and "enhancement" are types, but one is red and the other not, and I'd like to stay it that way.

Wouldn't mind for them to share a common prefix, though. But perhaps we can not use "type" but rather something else, like "kind" or "category" -- the word "type" already is used heavily in our code and I'd like to avoid yet another overload of the meaning.

Regarding the topics, note that they have either prefix topic: or package:. But I think that's manageable. Then there is release notes: highlight which is a bit of an odd one; and so I also kinda think it is OK to leave it like that. It is really meant in addition to whatever other labels you have, to mark select PRs / new features that we want to highlight.

Comment thread CHANGELOG.md Outdated
Comment on lines +99 to +103

Ping @HereAround , @friedemann2.

~~Note: I can not test this version locally at the moment because with the latest master branch in Oscar.jl my julia is complaining about an incompatibility with GAP and I can somehow not resolve this issue with the usual updating procedures. I plan to clean this branch up a little further, once it works on my machine again.~~ Had to throw away my `~/.julia` folder; now it seems to work. Still working on the updates, though.

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.

Tried using the release notes: use body label on #5512 but this did not work as I expected... ping @aaruni96

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.

The release notes entry in the PR body needs to be a level two header:

index1 = body.lower().find("## release notes")

but it is level one.

I will try changing the message and re-running it.

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.

After two more adjustments this did work:

  • The itemize needs to be done with - some text and not * some text
  • The list should not contain the PR link #1234 at the beginning since it will be added automatically.

Maybe the script can be adjusted further to be able to deal with these things but for now it did seem to work:

#### New features or extended functionality

- [#5032](https://github.com/oscar-system/Oscar.jl/pull/5032) Improve vector of minimal exponents method for cohomology computations
- [#5512](https://github.com/oscar-system/Oscar.jl/pull/5512) **Breaking:** Rename `all_cohomologies` to `sheaf_cohomology`
- [#5512](https://github.com/oscar-system/Oscar.jl/pull/5512) Support line bundle cohomology computation via local cohomology, including functorial aspects.

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.

I discussed this with @aaruni96 and he'll improve the script: instead of inserting "garbage", it will insert a suitable message about a parsing problem or so

I would suggest that we also make the script handle lists formatted with * instead of -.

@github-actions github-actions Bot force-pushed the update-changelog branch 5 times, most recently from 6f6bf4d to 5819e27 Compare November 27, 2025 16:20
@benlorenz
Copy link
Copy Markdown
Member

benlorenz commented Nov 27, 2025

@fingolfin @aaruni96 @lgoettgens What is the status of this now? If we want to create a release maybe tomorrow morning then this need to be completed, I just re-ran the script for 1.6.0 and it looks reasonable to me.
I just restarted the tests on #5578 (since the new singular.jl was released earlier today), and I guess this would be good to get in.

@aaruni96
Copy link
Copy Markdown
Member

I think the comments to improve the changelog script don't need to go in Oscar 1.6.0. Right now, with the current changes, the script produces a good changelog. The improvements suggested by @fingolfin above (to better handle strange cases, and accept * as list items) were not on my todo list for new release.

However, I can most likely make those changes by EOD, in case those changes should be made ASAP.

@benlorenz
Copy link
Copy Markdown
Member

benlorenz commented Nov 27, 2025

My comment was mostly regarding the changelog itself, not the script. I also think that further updates to the script can be done later. The current changelog in this PR looks good to me.

Comment thread CHANGELOG.md Outdated
Comment thread CHANGELOG.md Outdated
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 up to some very minor details in PR titles: I tweaked some (and saw someone else tweaked some more), so maybe we regenerate this a final time and then merge it?

@benlorenz benlorenz marked this pull request as ready for review November 28, 2025 14:00
@lgoettgens

This comment was marked as outdated.

Copy link
Copy Markdown
Member

@lgoettgens lgoettgens left a comment

Choose a reason for hiding this comment

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

I just did two more minor consistency changes and regenerated. LGTM now.

@benlorenz benlorenz merged commit 8d86e96 into master Nov 28, 2025
@benlorenz benlorenz deleted the update-changelog branch November 28, 2025 14:31
@lgoettgens lgoettgens added the release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes label Nov 28, 2025
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants