Skip to content

Commit c67b3dc

Browse files
authored
docs: document release process (#2834)
1 parent 9a14e1a commit c67b3dc

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,30 @@ See the [docs](https://test-utils.vuejs.org/).
2525

2626
Get started by running `pnpm install`. You can run the tests with `pnpm test`. That's it!
2727

28+
## Releasing
29+
30+
Releases are published to npm from GitHub Actions using npm trusted publishing.
31+
Publishing with npm tokens is disabled, so a release requires:
32+
33+
- write access to the `vuejs/test-utils` repository
34+
- the release commit to be on `main`
35+
- `package.json` to contain the version being released
36+
- approval from a maintainer with access to the `npm-publish` GitHub environment
37+
38+
To cut a release, push a version tag from `main`:
39+
40+
```sh
41+
git checkout main
42+
git pull
43+
git tag v2.x.y
44+
git push origin v2.x.y
45+
```
46+
47+
Pushing a `v*` tag starts the release workflow.
48+
The workflow builds the package, pauses for approval in the `npm-publish` environment,
49+
then publishes `@vue/test-utils` to npm after approval.
50+
The person who pushed the tag cannot self-approve the publish step.
51+
2852
## Contributing Docs
2953

3054
All the documentation files can be found in `docs`. It contains the English markdown files while translation(s) are stored in their corresponding `<lang>` sub-folder(s):

0 commit comments

Comments
 (0)