Skip to content
This repository was archived by the owner on Aug 7, 2021. It is now read-only.

Commit cff739d

Browse files
committed
docs(CONTRIBUTING): add steps for publishing
1 parent 7bfb013 commit cff739d

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

CONTRIBUTING.md

+39
Original file line numberDiff line numberDiff line change
@@ -144,3 +144,42 @@ NOTE: There are three test apps in the repository, located in the `/demo` direct
144144
```
145145
146146
Thank you for your contribution!
147+
148+
## Publishing new versions
149+
150+
1. Run `npm install` to install the dependencies and prepare the package for publishing.
151+
```bash
152+
npm install
153+
```
154+
155+
2. Remove the `package-lock.json` file if it was generated.
156+
```bash
157+
rm package-lock.json
158+
```
159+
160+
3. Add the following to your `.npmrc`.
161+
```
162+
tag-version-prefix=""
163+
message="release: cut the %s release"
164+
```
165+
166+
4. Create new branch for the release:
167+
```
168+
git checkout -b username/release-version
169+
```
170+
171+
5. Run `npm version` to bump the version in the `package.json`, tag the release and update the CHANGELOG.md:
172+
```
173+
npm version [patch|minor|major]
174+
```
175+
176+
6. Push all changes to your branch and create a PR.
177+
```bash
178+
git push --set-upstream origin username/release-version --tags
179+
```
180+
181+
7. Publish the package to npm after the PR is merged.
182+
```bash
183+
npm publish
184+
```
185+

0 commit comments

Comments
 (0)