Release: migrate release process to release-it

*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

Author: timmywil

.editorconfig

@@ -13,4 +13,3 @@ insert_final_newline = true
 [*.{json,yml}]
 indent_style = space
 indent_size = 2
-

.github/workflows/filestash.yml

@@ -10,11 +10,13 @@ permissions:
 
 jobs:
   update:
+    name: Update Filestash
     runs-on: ubuntu-latest
+    # skip on forks
+    if: ${{ github.repository == 'jquery/jquery' }}
     environment: filestash
     env:
       NODE_VERSION: 20.x
-    name: Update Filestash
     steps:
       - name: Checkout
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7

.github/workflows/verify-release.yml

@@ -0,0 +1,37 @@
+name: Reproducible Builds
+on:
+  push:
+    # On tags
+    tags:
+      - '*'
+  # Or manually
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to verify (>= 4.0.0-rc.1)'
+        required: false
+
+
+jobs:
+  run:
+    name: Verify release
+    runs-on: ubuntu-latest
+    # skip on forks
+    if: ${{ github.repository == 'jquery/jquery' }}
+    env:
+      NODE_VERSION: 20.x
+    steps:
+      - name: Checkout
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+
+      - name: Use Node.js ${{ env.NODE_VERSION }}
+        uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Install dependencies
+        run: npm ci
+
+      - run: npm run release:verify
+        env:
+          VERSION: ${{ github.event.inputs.version || github.ref_name }}

.gitignore

@@ -3,12 +3,12 @@
 *~
 *.diff
 *.patch
-/*.html
 .DS_Store
 .bower.json
 .sizecache.json
 yarn.lock
 .eslintcache
+tmp
 
 npm-debug.log*
 
@@ -23,6 +23,10 @@ npm-debug.log*
 /test/data/core/jquery-iterability-transpiled.js
 /test/data/qunit-fixture.js
 
-# Ignore BrowserStack files
+# Release artifacts
+changelog.html
+contributors.html
+
+# Ignore BrowserStack testing files
 local.log
 browserstack.err

.npmignore

@@ -1,12 +1,15 @@
 .eslintignore
+.eslintcache
 eslint.config.js
 
 /.editorconfig
 /.gitattributes
 /.mailmap
+/.sizecache.json
 
 /build
 /external
-/speed
 /test
-/Gruntfile.js
+/tmp
+/changelog.html
+/contributors.html

.release-it.js

@@ -0,0 +1,44 @@
+"use strict";
+
+const blogURL = process.env.BLOG_URL;
+
+if ( !blogURL || !blogURL.startsWith( "https://blog.jquery.com/" ) ) {
+	throw new Error( "A valid BLOG_URL must be set in the environment" );
+}
+
+// This is needed because until the release-it migration,
+// all the previous release tags were disconnected from the 3.x branch.
+// We can remove this if/when we do a 3.x release with the new setup.
+const from = process.env.FROM_VERSION;
+
+module.exports = {
+	preReleaseBase: 1,
+	hooks: {
+		"before:init": "bash ./build/release/pre-release.sh",
+		"after:version:bump":
+			"sed -i 's/main\\/AUTHORS.txt/${version}\\/AUTHORS.txt/' package.json",
+		"after:bump": "cross-env VERSION=${version} npm run build:all",
+		"before:git:release": "git add -f dist/ dist-module/ changelog.md",
+		"after:release": "echo 'Run the following to complete the release:' && " +
+			`echo './build/release/post-release.sh $\{version} ${ blogURL }'`
+	},
+	git: {
+
+		// Use the node script directly to avoid an npm script
+		// command log entry in the GH release notes
+		changelog: `node build/release/changelog.js ${ from ? from : "${from}" } $\{to}`,
+		commitMessage: "Release: ${version}",
+		getLatestTagFromAllRefs: true,
+		pushRepo: "[email protected]:jquery/jquery.git",
+		requireBranch: "main",
+		requireCleanWorkingDir: true
+	},
+	github: {
+		pushRepo: "[email protected]:jquery/jquery.git",
+		release: true,
+		tokenRef: "JQUERY_GITHUB_TOKEN"
+	},
+	npm: {
+		publish: true
+	}
+};

build/command.js

@@ -1,8 +1,6 @@
-"use strict";
-
-const { build } = require( "./tasks/build" );
-const yargs = require( "yargs/yargs" );
-const slimExclude = require( "./tasks/lib/slim-exclude" );
+import yargs from "yargs/yargs";
+import { build } from "./tasks/build.js";
+import slimExclude from "./tasks/lib/slim-exclude.js";
 
 const argv = yargs( process.argv.slice( 2 ) )
 	.version( false )

build/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

build/release.js

@@ -0,0 +1,123 @@
+# Releasing jQuery
+
+This document describes the process for releasing a new version of jQuery. It is intended for jQuery team members and collaborators who have been granted permission to release new versions.
+
+## Prerequisites
+
+Before you can release a new version of jQuery, you need to have the following tools installed:
+
+- [Node.js](https://nodejs.org/) (latest LTS version)
+- [npm](https://www.npmjs.com/) (comes with Node.js)
+- [git](https://git-scm.com/)
+
+## Setup
+
+1. Clone the jQuery repo:
+
+	```sh
+	git clone [email protected]:jquery/jquery.git
+	cd jquery
+	```
+
+1. Install the dependencies:
+
+	```sh
+	npm install
+	```
+
+1. Log into npm with a user that has access to the `jquery` package.
+
+	```sh
+	npm login
+	```
+
+The release script will not run if not logged in.
+
+1. Set `JQUERY_GITHUB_TOKEN` in the shell environment that will be used to run `npm run release`. The token can be [created on GitHub](https://github.com/settings/tokens/new?scopes=repo&description=release-it) and only needs the `repo` scope. This token is used to publish GitHub release notes and generate a list of contributors for the blog post.
+
+	```sh
+	export JQUERY_GITHUB_TOKEN=...
+	```
+
+The release script will not run without this token.
+
+## Release Process
+
+1. Ensure all milestoned issues/PRs are closed, or reassign to a new milestone.
+1. Verify all tests are passing in [CI](https://github.com/jquery/jquery/actions).
+1. Run any release-only tests, such as those in the [`test/integration`](../../test/integration/) folder.
+1. Ensure AUTHORS.txt file is up to date (this will be verified by the release script).
+
+	- Use `npm run authors:update` to update.
+
+1. Create draft blog post on blog.jquery.com; save the link before publishing. The link is required to run the release.
+
+	- Highlight major changes and reason for release.
+	- Add HTML from the `changelog.html` generated in the below release script.
+	- Use HTML from the `contributors.html` generated in the below release script in the "Thanks" section.
+
+1. Run a dry run of the release script:
+
+	```sh
+	BLOG_URL=https://blog.jquery.com/... npm run release -- -d
+	```
+
+1. If the dry run is successful, run the release script:
+
+	```sh
+	BLOG_URL=https://blog.jquery.com/... npm run release
+	```
+
+	This will run the pre-release script, which includes checking authors, running tests, running the build, and cloning the CDN and jquery-dist repos in the `tmp/` folder.
+
+	It will then walk you through the rest of the release process: creating the tag, publishing to npm, publishing release notes on GitHub, and pushing the updated branch and new tag to the jQuery repo.
+
+	Finally, it will run the post-release script, which will ask you to confirm the files prepared in `tmp/release/cdn` and `tmp/release/dist` are correct before pushing to the respective repos. It will also prepare a commit for the jQuery repo to remove the release files and update the AUTHORS.txt URL in the package.json. It will ask for confirmation before pushing that commit as well.
+
+	For a pre-release, run:
+
+	```sh
+	BLOG_URL=https://blog.jquery.com/... npm run release -- --preRelease=beta
+	```
+
+	`preRelease` can also be set to `alpha` or `rc`.
+
+	**Note**: `preReleaseBase` is set in the npm script to `1` to ensure any pre-releases start at `.1` instead of `.0`. This does not interfere with stable releases.
+
+1. Run the post-release script:
+
+	```sh
+	./build/release/post-release.sh $VERSION $BLOG_URL
+	```
+
+	This will push the release files to the CDN and jquery-dist repos, and push the commit to the jQuery repo to remove the release files and update the AUTHORS.txt URL in the package.json.
+
+1. Once the release is complete, publish the blog post.
+
+## Stable releases
+
+Stable releases have a few more steps:
+
+1. Close the milestone matching the current release: https://github.com/jquery/jquery/milestones. Ensure there is a new milestone for the next release.
+1. Update jQuery on https://github.com/jquery/jquery-wp-content.
+1. Update jQuery on https://github.com/jquery/blog.jquery.com-theme.
+1. Update latest jQuery version for [healthyweb.org](https://github.com/jquery/healthyweb.org/blob/main/wrangler.toml).
+1. Update the shipping version on [jquery.com home page](https://github.com/jquery/jquery.com).
+
+	```sh
+	git pull jquery/jquery.com
+	# Edit index.html and download.md
+	git commit
+	npm version patch
+	git push origin main --tags
+	```
+
+1. Update the version used in [jQuery docs demos](https://github.com/jquery/api.jquery.com/blob/main/entries2html.xsl).
+
+1. Email archives to CDNs.
+
+| CDN | Emails | Include |
+| --- | ------ | ------- |
+| Google | hosted-libraries@google | `tmp/archives/googlecdn-jquery-*.zip` |
+| Microsoft | damian.edwards@microsoft, Chris.Sfanos@microsoft | `tmp/archives/mscdn-jquery-*.zip` |
+| CDNJS | ryan@ryankirkman, thomasalwyndavis@gmail | Blog post link |