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

timmywil · 2024-07-18T15:09:52Z

Summary

3.x version of release migration, beginning with #5512, and including all changes from subsequent release PRs, including #5521. Some things were left in that were only applicable to the main branch and have no affect on 3.x-stable. I left those things in so that the code can be as close as possible to main, such as leaving in the factory regex in the verify script or leaving in the removal of dist-module in the build:clean script.

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

verify

use the last modified date of the commit before the tag
use versioned filenames when checking map files on the CDN
skip factory and package.json files when verifying CDN

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
limit certain workflows to the main repo (not forks)
version has been set to the previously released version 3.7.1, as release-it expects
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.

Ref jquery/jquery-release#114

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

*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 *verify* - use the last modified date of the commit before the tag - use versioned filenames when checking map files on the CDN - skip factory and package.json files when verifying CDN *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 - limit certain workflows to the main repo (not forks) - version has been set to the previously released version 3.7.1, as release-it expects - 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. - include post-release script to be run manually after a release, with further steps that should be verified manually Ref jquery/jquery-release#114 Closes jquerygh-5522

Ref jquerygh-5522

mgol

I compared the output with main and I have a few minor comments, but nothing blocking the merge. Nice to see 3.x migrated as well!

build/release/authors.js

build/release/dist.js

mgol · 2024-07-26T21:00:55Z

build/tasks/lib/compareSize.js

 import { exec as nodeExec } from "node:child_process";
-import isCleanWorkingDir from "./lib/isCleanWorkingDir.js";
+import chalk from "chalk";
+import isCleanWorkingDir from "./isCleanWorkingDir.js";


There's one difference from main in this file - the catch parameter in line 39 is named _ instead of e - do we want to align?

e should be an error. I wonder why there's no lint error on main.

The 3.x ESLint config has this override for build/**:

jquery/eslint.config.js

Line 287 in 3b23302

{ caughtErrorsIgnorePattern: "^_" }

which doesn't exist on main; that's why:

jquery/eslint.config.js

Lines 298 to 302 in a7d3383

rules: {

...jqueryConfig.rules,

"no-implicit-globals": "error",

strict: [ "error", "global" ]

}

Nvm, I forgot. The real reason is we've upgraded eslint in the 3.x branch to v9, which has caughtErrorsIgnorePattern, but the main branch is on v8, which is required for the import plugin. Support for flat config and eslint 9 is unlikely any time soon. We may have to consider dropping the import plugin.

I will still add the rule so we don't have to later, but it will have no effect until eslint is updated.

build/tasks/promises_aplus_tests.js

timmywil · 2024-07-29T17:19:37Z

Things to change on main that came up in this PR:

Adjust eslint settings for build files to also include rules for unused variables
Add package.json comment to dist

*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 *verify* - use the last modified date of the commit before the tag - use versioned filenames when checking map files on the CDN - skip factory and package.json files when verifying CDN *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 - limit certain workflows to the main repo (not forks) - version has been set to the previously released version 3.7.1, as release-it expects - 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. - include post-release script to be run manually after a release, with further steps that should be verified manually Ref jquery/jquery-release#114 Closes jquerygh-5522

Ref jquerygh-5522

*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 *verify* - use the last modified date of the commit before the tag - use versioned filenames when checking map files on the CDN - skip factory and package.json files when verifying CDN *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 - limit certain workflows to the main repo (not forks) - version has been set to the previously released version 3.7.1, as release-it expects - 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. - include post-release script to be run manually after a release, with further steps that should be verified manually Ref jquery/jquery-release#114 Closes gh-5522

Ref gh-5522

timmywil added the Release label Jul 18, 2024

timmywil added this to the 3.7.2 milestone Jul 18, 2024

timmywil requested a review from mgol July 18, 2024 15:09

timmywil mentioned this pull request Jul 18, 2024

Release: migrate release process to release-it #5306

Closed

2 tasks

timmywil changed the title ~~Release: migrate release process to release-it~~ Release: migrate release process to release-it (3.x) Jul 18, 2024

timmywil force-pushed the release-3.x-2 branch 2 times, most recently from 166676b to 1523542 Compare July 23, 2024 15:07

timmywil added a commit to timmywil/jquery that referenced this pull request Jul 23, 2024

Build: use --input-type=module in npm scripts

6628ba8

Ref jquerygh-5522

timmywil force-pushed the release-3.x-2 branch 2 times, most recently from 5efc345 to fb9c978 Compare July 24, 2024 13:27

mgol approved these changes Jul 26, 2024

View reviewed changes

timmywil mentioned this pull request Jul 29, 2024

Build: align eslint config with 3.x branch as much as possible #5524

Merged

2 tasks

timmywil added 3 commits July 29, 2024 15:22

Build: use --input-type=module in npm scripts

16c3a2d

Ref jquerygh-5522

Build: upgrade dependencies, including requirejs to 2.3.7

510159d

timmywil force-pushed the release-3.x-2 branch from e5ee090 to 510159d Compare July 29, 2024 19:23

timmywil merged commit 0b013ca into jquery:3.x-stable Jul 29, 2024

timmywil added a commit that referenced this pull request Jul 29, 2024

Build: use --input-type=module in npm scripts

fca1c56

Ref gh-5522

timmywil deleted the release-3.x-2 branch July 29, 2024 19:25

github-actions bot locked as resolved and limited conversation to collaborators Sep 24, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

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

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

Uh oh!

timmywil commented Jul 18, 2024 •

edited

Loading

Uh oh!

mgol left a comment

Uh oh!

Uh oh!

Uh oh!

mgol Jul 26, 2024

Uh oh!

timmywil Jul 29, 2024

Uh oh!

mgol Jul 29, 2024

Uh oh!

timmywil Jul 29, 2024 •

edited

Loading

Uh oh!

Uh oh!

timmywil commented Jul 29, 2024

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

	rules: {
	...jqueryConfig.rules,
	"no-implicit-globals": "error",
	strict: [ "error", "global" ]
	}

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

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

Uh oh!

Conversation

timmywil commented Jul 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

mgol left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mgol Jul 26, 2024

Choose a reason for hiding this comment

Uh oh!

timmywil Jul 29, 2024

Choose a reason for hiding this comment

Uh oh!

mgol Jul 29, 2024

Choose a reason for hiding this comment

Uh oh!

timmywil Jul 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

timmywil commented Jul 29, 2024

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

timmywil commented Jul 18, 2024 •

edited

Loading

timmywil Jul 29, 2024 •

edited

Loading