Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update changelog script #4719

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Conversation

aaruni96
Copy link
Member

@aaruni96 aaruni96 commented Mar 7, 2025

Updates the changelog workflow to allow for an optional basetag. Also pushes change log stuff to ignore list for CI

@aaruni96 aaruni96 added release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes backport 1.3.x backport for release branch 1.3 labels Mar 7, 2025
@aaruni96 aaruni96 requested a review from fingolfin March 7, 2025 20:36
@aaruni96
Copy link
Member Author

aaruni96 commented Mar 7, 2025

Result at #4720


#startdate = get_tag_date(basetag)
# HACK HACK HACK FIXME TODO WORKAROUND
startdate = "2024-10-30"
Copy link
Member

@fingolfin fingolfin Mar 8, 2025

Choose a reason for hiding this comment

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

I don't think we are quite yet ready to remove this workaround, are we? GitHub releases right now are not enough to tell us when the branch point was.

The two options I see right now are:

  1. we do a full cone of the Oscar repo after all and use git merge-base PREVTAG CURRENT_BRANCH (with CURRENT_BRANCH either master or release-X.Y I guess)
  2. we add a hardcoded list of relevant dates, and/or keep this one hardcoded date.

Copy link
Member Author

Choose a reason for hiding this comment

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

Sorry, you are right.
My changes work for now, because our patch release process is manually backporting stuff since last release. So, it should still be fine for 1.3.1, (and other 1.3.x), but not 1.4.0 (or 2.0), I think.

Copy link
Member Author

Choose a reason for hiding this comment

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

We bump the version in the readme everytime we branch off a release branch ( #4642 ). We can either label this with a new label like version-bump, or we can search for this (the name is quite predictable : gh pr list -S "Version 1.{current-minor}.0-dev" -s "merged" )

Then we can grab the date of whenever that PR was merged ?

@aaruni96 aaruni96 mentioned this pull request Mar 10, 2025
10 tasks
@@ -20,7 +20,7 @@


def usage(name: str) -> None:
print(f"Usage: `{name} [NEWVERSION]`")
print(f"Usage: `{name} [NEWVERSION] [OLDVERSION]`")
Copy link
Member

Choose a reason for hiding this comment

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

I don't understand why this needs to be added, what problem does it solve?

Copy link
Member Author

Choose a reason for hiding this comment

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

This would allow us to specify old version, so the script can find release date of old version (which in my head, does not necessarily need to be previously released version).

For example, lets say we release 1.3.1, and then 1.4, and then want to backport some critical thing to 1.3.2. Then the usage of the script like ./release_notes.py 1.3.2 1.3.1 would let us specify "only the pull requests closed since the release of 1.3.1, which have the backport 1.3.x label"

This is of course, only future proofing (and seemed like a great idea when I was changing .github/workflows/changelog.yml to include the optional version specifier input.

@aaruni96
Copy link
Member Author

The only thing that is currently holding back the 1.3.1 release is this PR (and the associated changelog PR produced by this script). Since there are still open issues with the changelog script which aren't addressed in this PR, should we just merge the changelog PR (#4720), and remove the backports label from this PR ?

@fingolfin

@aaruni96 aaruni96 requested a review from fingolfin March 12, 2025 14:57
@thofma
Copy link
Collaborator

thofma commented Mar 14, 2025

The only thing that is currently holding back the 1.3.1 release is this PR (and the associated changelog PR produced by this script). Since there are still open issues with the changelog script which aren't addressed in this PR, should we just merge the changelog PR (#4720), and remove the backports label from this PR ?

@fingolfin

I would be in favor of this.

@lgoettgens
Copy link
Member

The only thing that is currently holding back the 1.3.1 release is this PR (and the associated changelog PR produced by this script). Since there are still open issues with the changelog script which aren't addressed in this PR, should we just merge the changelog PR (#4720), and remove the backports label from this PR ?

@fingolfin

@fingolfin It would be great if we could get a decision on this, as then Aaruni could proceed with the 1.3.1 release

fingolfin
fingolfin previously approved these changes Mar 14, 2025
Copy link
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.

Fine by me -- BTW each of you could also have approved and merged this, I would have voice it if I had serious objections :-)

@lgoettgens
Copy link
Member

Fine by me -- BTW each of you could also have approved and merged this, I would have voice it if I had serious objections :-)

thofma's and my point was to NOT merge this, but instead remove the backport label

@lgoettgens lgoettgens removed the backport 1.3.x backport for release branch 1.3 label Mar 14, 2025
@lgoettgens lgoettgens dismissed fingolfin’s stale review March 14, 2025 14:34

just talked and we don't merge this right now

@lgoettgens
Copy link
Member

The only thing that is currently holding back the 1.3.1 release is this PR (and the associated changelog PR produced by this script). Since there are still open issues with the changelog script which aren't addressed in this PR, should we just merge the changelog PR (#4720), and remove the backports label from this PR ?

just talked with @fingolfin on gather, and this is how we would proceed.

so @aaruni96 you can go ahead with the changelog and release

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.

4 participants