Hightouch UI uses np to publish new releases.
Before publishing a release, disable the "Do not allow bypassing the above settings" setting in main
branch protection rules.
This is necessary for np
to push a release commit along with proper tags to the repository.
Don't forget to enable that setting back on after you're done.
To release a new version, run the following command:
npm run release
Hightouch UI follows the semver standard, so make sure to pick an appropriate version for your release.
After a new version is published, np
will open a release page here on GitHub for you to fill out.
Delete any changelog entries that aren't essential for the team to be aware of.
For example, if there's a commit for cleaning up readme, fixing code formatting or other changes that have zero impact on the end user of Hightouch UI, don't mention it in the release notes.