Performing releases

IMPORTANT

Releasing a new version makes sense only when there are changes that are significant for users. Therefore, the Unreleased section of the CHANGELOG.md in the main branch should not be empty.

To release a new version:

1. Create a pull request from the main branch to the release branch.

2. After agreement with the other team members, “Rebase and merge” this pull request. This will trigger the GitHub Action for the release.

3. Wait for the successful completion of the action. Success means that:

   • In the new commit (with the new version number in the title), the package version in package.json and CHANGELOG.md has been updated.
   • This commit has a tag with the version number, and the main and release branches have been updated.
   • Release notes for the new version have appeared in the Releases.
   • The new version of the package has been published on npmjs.org.
   • The documentation site has been published from the new version.

4. If the automation fails, check the GitHub Actions logs for troubleshooting.

If necessary, release @stylistic/stylelint-config.

NOTE

The release level is determined automatically based on the presence of certain subsections in the Unreleased section of the changelog:

• If there is “Changed” (with breaking changes) — it is always major, regardless of the presence of “Added” and “Fixed”.
• If there is “Added” (with new features) — it is minor, regardless of the presence of “Fixed”.
• If there is only “Fixed” (with bug fixes) — it is patch.

Prereleases

A branch named release-<suffix> publishes a prerelease instead, e.g. release-rc publishes release candidates, 6.0.0-rc.<n>. The package goes to npm under the dist-tag named by the suffix, rc, so npm add @stylistic/stylelint-plugin keeps installing the latest stable version.

Publishing the documentation

A release publishes the site by itself. Between releases, a correction of the documentation reaches the site through the deploy-docs branch: open a pull request from main to it and merge it, and the Docs workflow builds the site from the branch and publishes it. The workflow can also be started by hand from the Actions tab.