Skip to content

Releasing

Memet Zx edited this page Nov 14, 2026 · 1 revision

Releasing

Versions follow Semantic Versioning and every release is listed in the changelog.

Change Bump
Bug fixes only patch (1.1.0 to 1.1.1)
New tools or features, nothing breaks minor (1.1.0 to 1.2.0)
Something users or integrations rely on changes major (1.1.0 to 2.0.0)

Steps

  1. Add a ## [x.y.z] - YYYY-MM-DD section to CHANGELOG.md. Move entries out of Unreleased.

  2. Set the same version in package.json.

  3. Commit: git commit -s -m "Release vx.y.z: bump version and update changelog".

  4. Create a signed annotated tag and push everything:

    git tag -s vx.y.z -m "Mools x.y.z: short summary"
    git push origin master --tags

What happens next

The Release workflow:

  1. checks that the tag matches package.json and that the changelog has a section for it,
  2. runs the tests and the build,
  3. attaches the built site as a .tar.gz,
  4. publishes the GitHub release with the changelog section as its notes, marked as a pre-release for versions below 1.0.0 or tags with a suffix such as -rc.1.

The Deploy workflow publishes the site to GitHub Pages on every push to master, tagged or not.

Signed tags

The repository owner has GitHub's vigilant mode on, so unsigned tags show as "Unverified". Always use git tag -s. The repository sets tag.gpgsign true so this happens by default.

Fixing a tag

Deleting and re-creating a tag is possible but disruptive for anyone who fetched it. Prefer a new patch version.

Clone this wiki locally