Skip to content

Commit 9c623fb

Browse files
jeddy3romainmenkeybiquitous
authored
Document new release workflow (#8793)
Co-authored-by: Romain Menke <11521496+romainmenke@users.noreply.github.com> Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
1 parent f34b6b4 commit 9c623fb

File tree

2 files changed

+8
-13
lines changed

2 files changed

+8
-13
lines changed

docs/maintainer-guide/releases.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,14 @@
1010
2. [stylelint/stylelint-config-standard](https://github.com/stylelint/stylelint-config-standard)
1111
3. [stylelint/stylelint.io](https://github.com/stylelint/stylelint.io)
1212
5. Release Stylelint:
13-
1. Ensure `CHANGELOG.md` has the correct date (UTC) for the latest release.
14-
2. Add a summary about what's changed including if there's a new config.
15-
3. If necessary, reorder the changelog entries in the "Prepare x.y.z" pull request so that the widest-reaching changes come first.
16-
4. Merge the "Prepare x.y.z" pull request.
17-
5. Open a terminal window in the `stylelint` repository.
18-
6. Run `npm run release`.
19-
7. Select the version from the [`np`](https://github.com/sindresorhus/np) prompt that matches the one in the changelog.
20-
8. Confirm the publishing of the package to [www.npmjs.com/package/stylelint](https://www.npmjs.com/package/stylelint).
21-
9. Confirm the creation of the release at [stylelint/stylelint/releases](https://github.com/stylelint/stylelint/releases).
22-
6. If necessary, release `stylelint-config-*`:
23-
1. Change to the `stylelint-config-*` repository.
24-
2. Repeat steps 5 to 8 above for that repository.
13+
1. Trigger the `release-pr` workflow to create a release PR.
14+
2. Add a summary to the changelog about what's changed, including if there's a new standard config.
15+
3. If necessary, reorder the changelog entries so that the widest-reaching changes come first.
16+
4. Merge the PR to start the `release` workflow.
17+
5. Approve the pending release job to publish to npm and create a draft GitHub release.
18+
6. Confirm the publishing of the package to [www.npmjs.com/package/stylelint](https://www.npmjs.com/package/stylelint).
19+
7. Review and publish the draft GitHub release.
20+
6. If necessary, release `stylelint-config-*` using the same steps.
2521
7. Update the website:
2622
1. Go to the [releasing action page](https://github.com/stylelint/stylelint.io/actions/workflows/release-stylelint.yml) in the `stylelint.io` repository.
2723
2. Click **Run workflow**.

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,6 @@
7272
"lint:types": "tsc",
7373
"prepare": "husky && npm run build",
7474
"postprepare": "patch-package",
75-
"release": "np --no-release-draft",
7675
"pretest": "npm run lint",
7776
"test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
7877
"test-coverage": "npm test --ignore-scripts -- --coverage",

0 commit comments

Comments
 (0)