Skip to main content

Performing releases

  1. Create a new issue to announce the planned release:
    • include the template checklist
    • if applicable, list any new rules so that we can discuss including them in our configs
  2. If necessary, open a pull request to mark those rules in docs/user-guide/rules.md.
  3. Check if package tests in stylelint/stylelint-ecosystem-tester fail with the new version.
  4. If necessary, test the main branch locally against:
    1. stylelint/stylelint-config-recommended
    2. stylelint/stylelint-config-standard
    3. stylelint/stylelint.io
  5. Release Stylelint:
    1. Trigger the release-pr workflow to create a release PR.
    2. Add a summary to the changelog about what's changed, including if there's a new standard config.
    3. If necessary, reorder the changelog entries so that the widest-reaching changes come first.
    4. Merge the PR to start the release workflow.
    5. Approve the pending release job to publish to npm and create a draft GitHub release.
    6. Confirm the publishing of the package to www.npmjs.com/package/stylelint.
    7. Review and publish the draft GitHub release.
  6. If necessary, release stylelint-config-* using the same steps.
  7. Update the website:
    1. Go to the releasing action page in the stylelint.io repository.
    2. Click Run workflow.
    3. Check and merge a pull request created by the action.
    4. Confirm the deployment of the update to stylelint.io.
  8. Check that stylelint.io/demo installs the latest Stylelint and config versions.

New release issue template

- [ ] stylelint-ecosystem-tester check
- [ ] stylelint release
- [ ] stylelint-config-recommended update/release
- [ ] stylelint-config-standard update/release
- [ ] stylelint.io update
- [ ] stylelint-demo check