Skip to content

Commit 06c94d9

Browse files
committed
docs: add release steps
1 parent 59a3f83 commit 06c94d9

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,20 @@ Therefore, PRs are merged via one of two strategies:
8383
- rebase - branch cannot contain merge commits ([rebase instead of merge](https://www.atlassian.com/git/tutorials/merging-vs-rebasing)),
8484
- squash - single commit whose message is the PR title (should be in conventional commit format).
8585

86+
## Releases
87+
88+
We use nx release command to create releases for GitHub as well as publish to npm.
89+
90+
**Steps:**
91+
92+
- `git checkout main`, `git pull`
93+
- (recommended optional) `npx nx release --dryRun`
94+
- `npx nx release` and confirm publish prompt
95+
96+
**Env variable in `.env`:**
97+
98+
- `GITHUB_TOKEN=ghp_...` - to create a GitHub Release
99+
86100
## Project tags
87101

88102
[Nx tags](https://nx.dev/core-features/enforce-module-boundaries) are used to enforce module boundaries in the project graph when linting.

0 commit comments

Comments
 (0)