Skip to content

Commit 997e5c1

Browse files
committed
Document the release process
1 parent 7b610a5 commit 997e5c1

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,25 @@ Enforcing code styles should be mainly done with tools like [Prettier](https://p
3838
"extends": ["bloq", "bloq/node", "prettier"]
3939
}
4040
```
41+
42+
## Release process
43+
44+
Create a feature branch, commit and push the changes, and open a PR:
45+
46+
```sh
47+
git checkout -b $BRANCH
48+
# Commit the changes
49+
npm version $VERSION # Use major|minor|parch
50+
git push -u origin $BRANCH
51+
# Open a PR
52+
```
53+
54+
Once the PR is approved, merge the changes locally, apply and push a version tag, and create a release:
55+
56+
```sh
57+
git checkout master
58+
git merge --ff $BRANCH
59+
git tag -s -m "" v$(jq -r '.version' <package.json)
60+
git push --follow-tags
61+
# Create a new release
62+
```

0 commit comments

Comments
 (0)