| 1 | # Performing releases
|
| 2 |
|
| 3 | 1. Create a [new issue](https://github.com/stylelint/stylelint/issues/new) announcing the planned release, e.g. `Release 8.11.1` and include the [template checklist](#new-release-issue-template).
|
| 4 | 2. Locally test `master` in the `stylelint-config-*` shareable config repositories. Install current `master` branch (`npm install stylelint/stylelint#master`) and run tests.
|
| 5 | 3. Locally test `master` in the [stylelint/stylelint.io](https://github.com/stylelint/stylelint.io) repository.
|
| 6 | 4. Locally test `master` in the [stylelint/stylelint-demo](https://github.com/stylelint/stylelint-demo) repository.
|
| 7 | 5. Publish the package to npm and create a GitHub release using [`np`](https://github.com/sindresorhus/np):
|
| 8 | 1. [Consistently format](pull-requests.md) the [changelog](../../CHANGELOG.md).
|
| 9 | 2. Replace `## Head` with new version number e.g. `## 8.1.2`.
|
| 10 | 3. Commit these changes.
|
| 11 | 4. Push these changes.
|
| 12 | 5. Confirm the changes are correct at [https://github.com/stylelint/stylelint](https://github.com/stylelint/stylelint).
|
| 13 | 6. Run `npm run release`.
|
| 14 | 7. Select the version that matches the one from the changelog.
|
| 15 | 8. Copy and paste the changelog entries for the published version from [changelog](../../CHANGELOG.md) when the GitHub release page opens.
|
| 16 | 9. Confirm the publishing of the package to [https://www.npmjs.com/package/stylelint](https://www.npmjs.com/package/stylelint).
|
| 17 | 10. Confirm the creation of the release at [https://github.com/stylelint/stylelint/releases](https://github.com/stylelint/stylelint/releases).
|
| 18 | 6. If a new version of any `stylelint-config-*` is required, repeat step 5 for that repository.
|
| 19 | 7. Update the online demo by changing to the `stylelint-demo` repository:
|
| 20 | 1. Run `npm install -S stylelint@latest`.
|
| 21 | 2. Run `npm test`.
|
| 22 | 3. Commit these changes.
|
| 23 | 4. Push these changes.
|
| 24 | 5. Confirm the deployment of the update to [stylelint.io/demo](https://stylelint.io/demo).
|
| 25 | 8. Update the website documentation by changing to the `stylelint.io` repository:
|
| 26 | 1. Run `npm install -D stylelint@latest`.
|
| 27 | 2. Run `npm test`.
|
| 28 | 3. Commit these changes.
|
| 29 | 4. Push these changes.
|
| 30 | 5. Confirm the deployment of the update to [stylelint.io](https://stylelint.io).
|
| 31 | 9. Compose a tweet that:
|
| 32 | - announces the release
|
| 33 | - communicates what has changed
|
| 34 | - links to the appropriate heading in the changelog on [stylelint.io](https://stylelint.io).
|
| 35 |
|
| 36 | ## New release issue template
|
| 37 |
|
| 38 | ```markdown
|
| 39 | - [ ] stylelint release
|
| 40 | - [ ] stylelint-config-recommended update/release
|
| 41 | - [ ] stylelint-config-standard update/release
|
| 42 | - [ ] stylelint-demo update
|
| 43 | - [ ] stylelint.io update
|
| 44 | - [ ] tweet
|
| 45 |
|
| 46 | cc @stylelint/core
|
| 47 | ```
|