Skip to content

Commit c73bd78

Browse files
authored
Update README.md to include note on how we release npm packages (#82)
1 parent 2b04426 commit c73bd78

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,24 @@ To run the tests in watch mode (for <abbr title="test driven development&
3434
yarn run test:watch
3535
```
3636

37+
## Releasing alpha and production tagged packages to NPM
38+
### Releasing alpha and test packages
39+
- Use your Jira ticket to create your namespace. This will prevent collision as many people can be simultaneously working in the same repository.
40+
- run: **`npm version prerelease --preid=wedev-1234`**
41+
- this command will help auto-increment your alpha package tags inside your jira ticket namespace. refer to [npm versioning docs](https://docs.npmjs.com/cli/v11/commands/npm-version) & [guides for more info on command options](- this command will help auto-increment your alpha package tags inside your jira ticket namespace)
42+
- run: **`npm publish --tag alpha`** our most used development tags are: alpha, canary
43+
44+
### Releasing production level package
45+
We like to create a pull request specifically after the expected changes are merged into the main branch.
46+
Steps:
47+
- create PR with version number as branch name. Ex, if the next version is 3.2.1, your git command will be: `git checkout -b v3.2.1`
48+
- in the new branch, run the following:
49+
1. **`git pull --tags`** to fetch all git tags
50+
2. **`npm version X.X.X`** to set the new tag WITH the commit git tagged
51+
3. **`git push --tags`**
52+
4. **`npm publish`**
53+
- Note: version numbers must start at minimum, with 1 (1.x.x) in order for consumers to automatically receive patch updates (no tags starting with 0, like 0.x.x)
54+
3755
## Linting with ESLint, Prettier, and Types
3856
To scan the project for linting errors, run
3957
```bash

0 commit comments

Comments
 (0)