Skip to content
This repository was archived by the owner on Jun 28, 2024. It is now read-only.

Commit 71a5c1b

Browse files
committed
add info about releasing via GitHub actions
1 parent 12453d6 commit 71a5c1b

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

CONTRIBUTING.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -94,11 +94,20 @@ Our pre-commit hooks verify that the linter and tests pass when committing.
9494

9595
### Publishing to npm
9696

97+
#### Releasing via GitHub Actions
98+
99+
To release a new version of the package, navigate to `Actions` >
100+
`Release package` workflow and trigger it with the chosen release type. The
101+
workflow will update the package version in `package.json`, release the package
102+
to NPM, create a new git tag and a GitHub release.
103+
104+
#### Releasing manually
105+
97106
We use [release-it](https://github.com/release-it/release-it) to make it easier
98-
to publish new versions. It handles common tasks like bumping version based on
99-
semver, creating tags and releases etc.
107+
to publish new versions manually. It handles common tasks like bumping version
108+
based on semver, creating tags and releases etc.
100109

101-
To publish new versions, run the following:
110+
To publish a new version, run the following:
102111

103112
```sh
104113
yarn release

0 commit comments

Comments
 (0)