Release: migrate release process to release-it #5512

timmywil · 2024-06-17T16:33:14Z

Summary

This migrates the release process from jquery-release to release-it and some custom scripts.
Also, now that we no longer need to build on Node 10 or maintain jquery-release scripts, this PR migrates all files in the build folder to use ESM.
Moved the dist and dist-module wrapper files to wrappers/ folders to make packaging and cleaning release-only files easier. All references to those files have been updated and it should have no effect on the exports.

Authors

Checking and updating authors has been migrated
to a custom script in the repo

Changelog

changelogplease is no longer maintained; replace with custom script
generate changelog in markdown for GitHub releases
generate changelog in HTML for blog posts

dist

clone dist repo, copy files, and commit/push
commit tag with dist files on main branch;
remove dist files from main branch after release

cdn

clone cdn repo, copy files, and commit/push
create versioned and unversioned copies in cdn/
generate md5 sums and archives for Google and MSFT

Checklist

New tests have been added to show the fix or feature works
If needed, a docs issue/PR was created at https://github.com/jquery/api.jquery.com

This PR currently has feature parity with jquery-release, but these are a few things I'd like to add:

Future Improvements

Add workflow to verify new release builds are reproducible
Document updated release process in build/release/README.md
Generate contributors list with links to GH profiles
(stable only) Update version in jquery.com repo
(stable only) Update version in jquery-wp-content
(stable only) Update version in api.jquery.com demos (entries2html.xsl)
(optional) Close GH milestone

build/release/validBlogUrl.js

*Authors* - Checking and updating authors has been migrated to a custom script in the repo *Changelog* - changelogplease is no longer maintained - generate changelog in markdown for GitHub releases - generate changelog in HTML for blog posts *dist* - clone dist repo, copy files, and commit/push - commit tag with dist files on main branch; remove dist files from main branch after release *cdn* - clone cdn repo, copy files, and commit/push - create versioned and unversioned copies in cdn/ - generate md5 sums and archives for Google and MSFT *misc* - now that we don't need the jquery-release script and now that we no longer need to build on Node 10, we can use ESM in all files in the build folder - move dist wrappers to "wrappers" folders for easy removal of all built files Fixes jquery/jquery-release#114 Closes jquerygh-5512

timmywil · 2024-06-21T13:56:33Z

I've tested each step of this individually. The final test will be to try a real release, but we can wait until after the next beta release.

*Authors* - Checking and updating authors has been migrated to a custom script in the repo *Changelog* - changelogplease is no longer maintained - generate changelog in markdown for GitHub releases - generate changelog in HTML for blog posts *dist* - clone dist repo, copy files, and commit/push - commit tag with dist files on main branch; remove dist files from main branch after release *cdn* - clone cdn repo, copy files, and commit/push - create versioned and unversioned copies in cdn/ - generate md5 sums and archives for Google and MSFT *misc* - now that we don't need the jquery-release script and now that we no longer need to build on Node 10, we can use ESM in all files in the build folder - move dist wrappers to "wrappers" folders for easy removal of all built files Fixes jquery/jquery-release#114 Closes jquerygh-5512

timmywil · 2024-07-01T18:38:57Z

I realized we can go ahead and review this. I'd like to add a couple things that jquery-release didn't have for stable releases, but those things are optional and could be added in future PRs.

*Authors* - Checking and updating authors has been migrated to a custom script in the repo *Changelog* - changelogplease is no longer maintained - generate changelog in markdown for GitHub releases - generate changelog in HTML for blog posts *dist* - clone dist repo, copy files, and commit/push - commit tag with dist files on main branch; remove dist files from main branch after release *cdn* - clone cdn repo, copy files, and commit/push - create versioned and unversioned copies in cdn/ - generate md5 sums and archives for Google and MSFT *misc* - now that we don't need the jquery-release script and now that we no longer need to build on Node 10, we can use ESM in all files in the build folder - move dist wrappers to "wrappers" folders for easy removal of all built files Fixes jquery/jquery-release#114 Closes jquerygh-5512

mgol

It'll be great to have reproducible builds!

I added some comments.

.github/workflows/verify-release.yml

.gitignore

.npmignore

.release-it.cjs

build/release/verify.js

build/release/README.md

mgol

LGTM. Remaining comments can be addressed separately later.

build/release/README.md

*Authors* - Checking and updating authors has been migrated to a custom script in the repo *Changelog* - changelogplease is no longer maintained - generate changelog in markdown for GitHub releases - generate changelog in HTML for blog posts - generate contributors list in HTML for blog posts *dist* - clone dist repo, copy files, and commit/push - commit tag with dist files on main branch; remove dist files from main branch after release *cdn* - clone cdn repo, copy files, and commit/push - create versioned and unversioned copies in cdn/ - generate md5 sums and archives for Google and MSFT *build* - implement reproducible builds and verify release builds * uses the last modified date for the latest commit * See https://reproducible-builds.org/ - the verify workflow also ensures all files were properly published to the CDN and npm *docs* - the new release workflow is documented at build/release/README.md *misc* - now that we don't need the jquery-release script and now that we no longer need to build on Node 10, we can use ESM in all files in the build folder - move dist wrappers to "wrappers" folders for easy removal of all built files - limit certain workflows to the main repo (not forks) - version in package.json has been set to beta.1 so that the next release will be beta.2 - release-it added the `preReleaseBase` option, which should be set to `1` for the first pre-release of a type. For example, `--preRelease=beta --preReleaseBase=1` will release `.beta.1` as the first beta release, rather than `.beta.0`. Fixes jquery/jquery-release#114 Closes jquerygh-5512

timmywil · 2024-07-10T15:52:33Z

Changes since last approval:

Now generating a contributors.html that includes author names and links to their GH profiles for use in the blog post "Thanks" section. So much better than what I was using before! I was looking up each GH username manually.
Added a "Setup" section to the release README, which includes basic setup instructions like cloning and installing dependencies, but more importantly setup instructions for logging into npm and ensuring a github token is set in the environment, with an easy link to create a new token if necessary. The token is used for publishing release notes on GH and generating the contributors list with GH profile links.
Updated release-it to 17.5.0, which includes the new --preReleaseBase option, which we now always set to 1 in the npm script. This ensures all pre-releases of a kind start at .1 instead of .0 and is a noop for stable releases.
Updated AUTHORS.txt to prepare for the upcoming release.

*Authors* - Checking and updating authors has been migrated to a custom script in the repo *Changelog* - changelogplease is no longer maintained - generate changelog in markdown for GitHub releases - generate changelog in HTML for blog posts - generate contributors list in HTML for blog posts *dist* - clone dist repo, copy files, and commit/push - commit tag with dist files on main branch; remove dist files from main branch after release *cdn* - clone cdn repo, copy files, and commit/push - create versioned and unversioned copies in cdn/ - generate md5 sums and archives for Google and MSFT *build* - implement reproducible builds and verify release builds * uses the last modified date for the latest commit * See https://reproducible-builds.org/ - the verify workflow also ensures all files were properly published to the CDN and npm *docs* - the new release workflow is documented at build/release/README.md *misc* - now that we don't need the jquery-release script and now that we no longer need to build on Node 10, we can use ESM in all files in the build folder - move dist wrappers to "wrappers" folders for easy removal of all built files - limit certain workflows to the main repo (not forks) - version in package.json has been set to beta.1 so that the next release will be beta.2 - release-it added the `preReleaseBase` option and we now always set it to `1` in the npm script. This is a noop for stable releases. Fixes jquery/jquery-release#114 Closes jquerygh-5512

build/release/README.md

mgol

Still LGTM after the latest changes. Just a small note on leftover larger numbers in lists.

*Authors* - Checking and updating authors has been migrated to a custom script in the repo *Changelog* - changelogplease is no longer maintained - generate changelog in markdown for GitHub releases - generate changelog in HTML for blog posts - generate contributors list in HTML for blog posts *dist* - clone dist repo, copy files, and commit/push - commit tag with dist files on main branch; remove dist files from main branch after release *cdn* - clone cdn repo, copy files, and commit/push - create versioned and unversioned copies in cdn/ - generate md5 sums and archives for Google and MSFT *build* - implement reproducible builds and verify release builds * uses the last modified date for the latest commit * See https://reproducible-builds.org/ - the verify workflow also ensures all files were properly published to the CDN and npm *docs* - the new release workflow is documented at build/release/README.md *misc* - now that we don't need the jquery-release script and now that we no longer need to build on Node 10, we can use ESM in all files in the build folder - move dist wrappers to "wrappers" folders for easy removal of all built files - limit certain workflows to the main repo (not forks) - version in package.json has been set to beta.1 so that the next release will be beta.2 - release-it added the `preReleaseBase` option and we now always set it to `1` in the npm script. This is a noop for stable releases. Fixes jquery/jquery-release#114 Closes jquerygh-5512

*Authors* - Checking and updating authors has been migrated to a custom script in the repo *Changelog* - changelogplease is no longer maintained - generate changelog in markdown for GitHub releases - generate changelog in HTML for blog posts - generate contributors list in HTML for blog posts *dist* - clone dist repo, copy files, and commit/push - commit tag with dist files on main branch; remove dist files from main branch after release *cdn* - clone cdn repo, copy files, and commit/push - create versioned and unversioned copies in cdn/ - generate md5 sums and archives for Google and MSFT *build* - implement reproducible builds and verify release builds * uses the last modified date for the latest commit * See https://reproducible-builds.org/ - the verify workflow also ensures all files were properly published to the CDN and npm *docs* - the new release workflow is documented at build/release/README.md *misc* - now that we don't need the jquery-release script and now that we no longer need to build on Node 10, we can use ESM in all files in the build folder - move dist wrappers to "wrappers" folders for easy removal of all built files - limit certain workflows to the main repo (not forks) - version in package.json has been set to beta.1 so that the next release will be beta.2 - release-it added the `preReleaseBase` option and we now always set it to `1` in the npm script. This is a noop for stable releases. Fixes jquery/jquery-release#114 Closes gh-5512

timmywil added Build Release labels Jun 17, 2024

github-advanced-security bot found potential problems Jun 17, 2024

View reviewed changes

build/release/validBlogUrl.js Fixed Show fixed Hide fixed

timmywil force-pushed the release branch from a6dba4c to b15a66f Compare June 21, 2024 13:53

timmywil marked this pull request as ready for review June 21, 2024 13:55

timmywil marked this pull request as draft June 22, 2024 21:19

timmywil force-pushed the release branch 2 times, most recently from c3001dd to 5d4d591 Compare June 29, 2024 19:33

timmywil requested a review from mgol July 1, 2024 18:33

timmywil marked this pull request as ready for review July 1, 2024 18:33

timmywil force-pushed the release branch from 5d4d591 to 4c3c17f Compare July 4, 2024 18:21

timmywil force-pushed the release branch from 7835086 to bb20a5e Compare July 4, 2024 18:33

mgol requested changes Jul 5, 2024

View reviewed changes

mgol reviewed Jul 8, 2024

View reviewed changes

build/release/README.md Outdated Show resolved Hide resolved

timmywil requested a review from mgol July 8, 2024 20:06

mgol mentioned this pull request Jul 8, 2024

Build: Bump ws from 8.17.0 to 8.17.1 #5513

Closed

mgol approved these changes Jul 9, 2024

View reviewed changes

build/release/README.md Outdated Show resolved Hide resolved

mgol reviewed Jul 9, 2024

View reviewed changes

build/release/README.md Outdated Show resolved Hide resolved

timmywil mentioned this pull request Jul 9, 2024

docs(readme): document testing process for outside contributors jquery/jquery-wp-docker#6

Merged

mgol mentioned this pull request Jul 9, 2024

Build: Bump braces from 3.0.2 to 3.0.3 #5511

Closed

timmywil force-pushed the release branch from 79d2415 to 8ccf199 Compare July 10, 2024 15:44

timmywil force-pushed the release branch from 8ccf199 to a33a431 Compare July 10, 2024 16:13

timmywil force-pushed the release branch from a33a431 to f8e812a Compare July 10, 2024 16:28

mgol reviewed Jul 10, 2024

View reviewed changes

build/release/README.md Outdated Show resolved Hide resolved

mgol approved these changes Jul 10, 2024

View reviewed changes

timmywil added 2 commits July 11, 2024 09:55

Release: update AUTHORS.txt

bbe14c8

timmywil force-pushed the release branch from f8e812a to bbe14c8 Compare July 11, 2024 13:55

timmywil merged commit 862e7a1 into jquery:main Jul 11, 2024
13 checks passed

timmywil deleted the release branch July 11, 2024 14:00

mgol added this to the 4.0.0 milestone Jul 12, 2024

timmywil mentioned this pull request Jul 18, 2024

Release: migrate release process to release-it (3.x) #5522

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release: migrate release process to release-it #5512

Release: migrate release process to release-it #5512

timmywil commented Jun 17, 2024 •

edited

Loading

timmywil commented Jun 21, 2024 •

edited

Loading

timmywil commented Jul 1, 2024

mgol left a comment

mgol left a comment

timmywil commented Jul 10, 2024 •

edited

Loading

mgol left a comment

Release: migrate release process to release-it #5512

Release: migrate release process to release-it #5512

Conversation

timmywil commented Jun 17, 2024 • edited Loading

Summary

Checklist

Future Improvements

timmywil commented Jun 21, 2024 • edited Loading

timmywil commented Jul 1, 2024

mgol left a comment

Choose a reason for hiding this comment

mgol left a comment

Choose a reason for hiding this comment

timmywil commented Jul 10, 2024 • edited Loading

mgol left a comment

Choose a reason for hiding this comment

timmywil commented Jun 17, 2024 •

edited

Loading

timmywil commented Jun 21, 2024 •

edited

Loading

timmywil commented Jul 10, 2024 •

edited

Loading