3.1 KiB
3.1 KiB
Performing releases
The primary goals are:
- Publishing the updated package to npm.
- Creating a GitHub release with notes.
The secondary goals are:
- Ensuring the stylelint org's
stylelint-config-*shareable configs are compatible with the release. - Updating the online demo at https://stylelint.io/demo to use the release.
- Updating the documentation at https://stylelint.io to use the release.
- Sending out a tweet.
Process
- Create a new issue announcing the planned release, e.g.
Release 8.11.1and include the template checklist. - Locally test
masterin thestylelint-config-*shareable configs repos. Install currentmasterbranch (npm install stylelint/stylelint#master) and run tests. - Locally test
masterin thestylelint.iorepo. - Locally test
masterin thestylelint-demorepo. - Both the publishing of the package to npm and the creating a github release are done with
np:- Ensure the CHANGELOG is consistently formatted.
- Replace
## Headwith new version number e.g.## 8.1.2. - Commit and push up these changes.
- Go to https://github.com/stylelint/stylelint and confirm these changes are correct and pushed up.
- Run
npm run release. Select correct version that matches the one from changelog. - When GitHub release page opened, copy changelog for published version from CHANGELOG.md to GitHub release.
- Go to https://www.npmjs.com/package/stylelint and confirm the package was published correctly.
- Go to https://github.com/stylelint/stylelint/releases and confirm the release was created correctly.
- If a new version of any
stylelint-config-*is required, repeat step 5 for that repo. - Update the online demo by changing to the
stylelint-demorepo:- Run
npm install -S stylelint@latest - Run
npm test - Commit and push up these changes.
- Go to https://stylelint.io/demo and confirm the update was automatically deployed.
- Run
- Update the website documentation by changing to the
stylelint.iorepo:- Run
npm install -D stylelint@latest - Run
npm test - Commit and push up these changes.
- Go to https://stylelint.io and confirm the update was deployed correctly. (It takes some time for Netlify to publish)
- Run
- Compose a tweet that announces the release, communicates what has changed and links to the appropriate heading in the CHANGELOG on https://stylelint.io.
New Release Issue Template
- [ ] stylelint release
- [ ] stylelint-config-recommended update/release
- [ ] stylelint-config-standard update/release
- [ ] stylelint-demo update
- [ ] stylelint.io update
- [ ] tweet
cc @stylelint/core