Before creating a release make sure that all changes are merged to the main branch.
- Update the version number to X.Y.Z
git checkout main
git pull
npm version X.Y.Z
The last command updates the version in package.json and package-lock.json and creates a git tag vX.Y.Z
- Push the changes to Github
git push
git push origin vX.Y.Z
- Create a release on Github
Creating a release on Github is a manual step. For more information see: https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository
Create the release from the existing tag we just created. For the title of the release use vX.Y.Z. Use the Generate releasenotes button to list all pull request that are included in this release. When the release is created the Github workflow '.github/workflows/npm-publish' will run automatically to deploy the new version to https://www.npmjs.com/package/@deltares/fews-pi-requests.