Skip to content

Commit

Permalink
docs(readme): add manual release process steps to the README.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
simplymichael committed Dec 14, 2023
1 parent be5493b commit e49cdd0
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -409,6 +409,21 @@ validator.addValidator(validatorName, validatorFunc, validatorMeta);
- Run all tests with coverage report: `npm run test:coverage`.


## Release process (manual)
- Checkout main branch: `git checkout main`.
- Merge latest changes from develop into main branch: `git merge develop`.
- Bump version number in package.json file.
- Build: `npm run build`.
- Commit build and version number bump:
`git commit -m "Build latest version and bump version number from <prev_ver> to <curr_ver>"`.
- Tag build: `git tag -a vx.x.x -m "<tag summary>"`.
- Push to github: `git push && git push origin --tags`.
- Draft release on GitHub (optional).
- Publish to NPM: `npm publish`.
- Checkout develop branch: `git checkout develop`.
- Merge updates from main branch into develop: `git merge main`.





Expand Down

0 comments on commit e49cdd0

Please sign in to comment.