Skip to content

Latest commit

 

History

History
127 lines (95 loc) · 4.71 KB

RELEASE.md

File metadata and controls

127 lines (95 loc) · 4.71 KB
Raw

Release process

This guide walks you through the QUnit release.

QUnit aims for its releases to be reproducible. Recent releases are automatically verified on a regular basis (reproducible builds status). Read more on Wikipedia, and reproducible-builds.org.

⚠️ WARNING ⚠️

Before starting, make sure you have:

System prerequisites:

  • Node.js 14, or later.
  • Git 2.11, or later.

Ensure that all changes for this release have been merged into the main branch. For patch releases, try landing any other bug fixes; for minor releases, ensure new features have been documented and tested. Major releases likely have their own checklist.

  1. Create a local release branch, and ensure it is up-to-date: Verify that the canonical repository is cloned (not a fork):

    git remote -v
# …
# origin	git@github.com:qunitjs/qunit.git

    Create or reset the release branch:

    git remote update && git checkout -B release -t origin/main

  2. Install dev dependencies:

    npm ci

  3. Create the release preparation commit:

    node build/prep-release.js @VERSION
    • Use git add -p to review the changes.
    • In AUTHORS.txt, if you see duplicate entries, then use the .mailmap file to normalize them to a canonical name and e-mail address, and then re-run the above command.
    • Edit History.md to remove changes not relevant to end-users (e.g. changes relating to tests, build, internal refactoring, doc fixes, etc.).

Commit your changes with the following message (replace @VERSION with the release version):

Build: Prepare @VERSION release

Push the release branch to GitHub. Once CI is passing, push again, this time to the (protected) main branch.

Performing the release

Verify that your local repo is at the release preparation commit:

git show
# Build: Prepare x.y.z release
# …

  1. Build the release:

    node build/build-release.js @VERSION

    This script does not need any credentials or permissions, and may be run in a container that can only read-write the current directory. This will edit package.json and bower.json, then execute npm run build to generate the release artifacts, then create a local clone of jquery/codeorigin.jquery.com, and prepare a local commit for you to later push.

    Review the release artifacts, compared to the previous release.

    node build/review-package.js @LAST_VERSION

# … reviews package.json, qunit.js, and qunit.css

  2. Publish to GitHub.
    ⚠️ Do not push to the main branch!

    git add -f package.json bower.json qunit/
git commit -m "Release @VERSION"
git tag -s "@VERSION" -m "Release @VERSION"
git push --tags

  3. Publish to npm:

    npm publish

    This will bundle the current directory and publish it to npm with the name and version specified in package.json. Verify that the release is displayed at https://www.npmjs.com/package/qunit.

  4. Publish to the jQuery CDN: Review the commit and push it:

    cd __codeorigin
git show
git push

    Verify that the release is listed at https://code.jquery.com/qunit/ and that you can open the JS/CSS files.

Updating the website

After the release is published, we need to update the website.

Check out the main branch of the qunitjs/qunit repository, and ensure it is clean and up-to-date. Run the following script, which will update release links and demos to use the new version:

qunit$ node build/site-set-version.js VERSION

Stage the changes it made, and commit with the following message:

Docs: Update url and version to VERSION

Push the commit to a branch on origin, wait CI checks to complete, then re-push to the main branch. Check the website in a few minutes to verify the change (deployment log).

Final steps

You're almost there! Make sure you update GitHub releases using the changelog from History.md.

That's it! If you made it this far, congratulations you have successfully released a version of QUnit!

If anything in the above was inaccurate or unclear, improve it to mmake future releases easier!