When releasing a new version of the library, make sure to follow these steps:
Pre-release recommendations:
- Make sure to check if there are any styling or code errors by running lint tools defined in package.json
Release steps:
- Make sure the tests pass for your branch in CI
- Merge your branch to main
- Determine the next version of the library by following the SemVer guidelines
- Update version in package.json
- Compile the latest version (details how to run command are in the package.json)
- Make sure the tests pass locally (details how to run them in the package.json)
- Update CHANGELOG.md with the latest release details
- Compile the docs (details in the package.json - unless it's a very small change)
- Push the changes to Github and wait for tests to pass in CI
- Push the changes to NPM with
npm publish - Update any related content in the Github wiki
- Add release version in the Github releases so it has a tag.