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

Build: Backport changelog generation from jQuery #251

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mgol
Copy link
Member

@mgol mgol commented Mar 17, 2025

For some reason, read -p doesn't work in the pre-release.sh script - or at least that's my hypothesis why the script gets stuck on pre-release. I thought since Code is using it in post-release.sh, it should also work in pre-release.sh, but maybe not?

Hopefully, now it'll work. My previous testing was limited as dry-run doesn't show all these issues, so I merged the release-it PR and I tried to release an alpha for testing; that's when I hit the issue.

Backport the changelog generation script from jQuery Core. Rename the old CHANGELOG.md to LEGACY_CHANGELOG.md to not lose it, but I'm contemplating moving it to GitHub Releases. Move current CHANGELOG.md entries to GitHub Releases.

@mgol mgol added this to the 4.0.0 milestone Mar 17, 2025
@mgol mgol requested a review from timmywil March 17, 2025 23:46
@mgol mgol self-assigned this Mar 17, 2025
@timmywil
Copy link
Member

I think I prefer posting the generated changelog to github release notes. Do you agree?

@mgol
Copy link
Member Author

mgol commented Mar 31, 2025

I think I prefer posting the generated changelog to github release notes. Do you agree?

Yeah, that would be more similar to other projects; I just wander what to do with the legacy changelog entries. Should I just create releases on GitHub for them all and then drop the legacy changelog?

@timmywil
Copy link
Member

I think you could just leave it for historical purposes and add a note to the top that says all release notes since are in GitHub releases.

@mgol
Copy link
Member Author

mgol commented Mar 31, 2025

Cool, so are there any code changes needed beyond the note at the top? Keeping the changelog.md file in the repository with the changelog for the last release is what jQuery does as well right now.

@timmywil
Copy link
Member

I guess not.

@mgol
Copy link
Member Author

mgol commented Mar 31, 2025

@timmywil I went ahead and copied all info from the old changelog to GitHub Releases: https://github.com/jquery/jquery-mousewheel/releases. This repo only has data for version 3.0.0 & up as previous ones were apparently not on Git so I posted all changelog entries up until 3.0.3 in a single entry; newer ones all have separate entries.

I removed the legacy changelog from this PR. PTAL.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants