Skip to content

Backfill 1.2.2 to changelog#4472

Closed
aaruni96 wants to merge 4 commits intooscar-system:masterfrom
aaruni96:ak96/add-122-to-changelog
Closed

Backfill 1.2.2 to changelog#4472
aaruni96 wants to merge 4 commits intooscar-system:masterfrom
aaruni96:ak96/add-122-to-changelog

Conversation

@aaruni96
Copy link
Copy Markdown
Member

This depends on #4448 , just a first draft of what a backfilled changelog for v1.2.2 could look like.

This skips the following compared to the autogenerated changelog in the release page :

@aaruni96 aaruni96 requested a review from fingolfin January 16, 2025 13:38
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.

Thank you, I think this is a good idea in principle.

But I would suggest to link to the PRs that implemented a fix. That way one can easily find out more information about a given fix.

Comment thread CHANGELOG.md Outdated
Comment thread CHANGELOG.md Outdated
Co-authored-by: Max Horn <max@quendi.de>
@fingolfin
Copy link
Copy Markdown
Member

BTW, not a complaint, but, why isn't this in PR #4448? Don't they basically do the same thing, i.e. add CHANGELOG.md, just with different content?

Comment thread CHANGELOG.md

### Fixed

- Fixed a problem with `galois_group` [PR #4396](https://github.com/oscar-system/Oscar.jl/pull/4396)
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.

That's better. I've now adjusted #4396 to use this as title, and added the "use title" label.

We also should add labels reflecting the categories we use. While I am still not convinced that "Added" / "Changed" / etc. are what we want (after all the description usually makes that clear already: "Fixed a problem with ..."), I am OK with trying that out for now, we can then iterate.

But that would suggestion suitable labels. E.g. category: change, category: fix, category: addition (or any different prefix, like kind: or type:. Or no prefix, whatever. As long as there is a way to find out which labels are relevant. Having a common prefix simply makes that easier)

@aaruni96
Copy link
Copy Markdown
Member Author

aaruni96 commented Jan 16, 2025

why isn't this in PR #4448?

I didn't want to conflate the two discussions : tracking new changes in a changelog file v/s how to backfill the changelog .

I can close this in favor of #4448 (and add these changes there) if you prefer.

@aaruni96
Copy link
Copy Markdown
Member Author

Closed in favor of #4448

@aaruni96 aaruni96 closed this Jan 29, 2025
@aaruni96 aaruni96 deleted the ak96/add-122-to-changelog branch April 23, 2026 23:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants