| 1 | <a href="https://postmarkapp.com">
|
| 2 | <img src="https://github.com/ActiveCampaign/postmark.js/raw/main/postmark.png" alt="Postmark Logo" title="Postmark" width="120" height="120" align="right">
|
| 3 | </a>
|
| 4 |
|
| 5 | # Release process
|
| 6 |
|
| 7 | When releasing a new version of the library, make sure to follow these steps:
|
| 8 |
|
| 9 | Pre-release recommendations:
|
| 10 |
|
| 11 | * Make sure to check if there are any styling or code errors by running lint tools defined in package.json
|
| 12 |
|
| 13 | Release steps:
|
| 14 |
|
| 15 | 1. Make sure the tests pass for your branch in CI
|
| 16 | 1. Merge your branch to main
|
| 17 | 1. Determine the next version of the library by following the [SemVer](https://semver.org/) guidelines
|
| 18 | 1. Update version in package.json
|
| 19 | 1. Compile the latest version (details how to run command are in the package.json)
|
| 20 | 1. Make sure the tests pass locally (details how to run them in the package.json)
|
| 21 | 1. Update CHANGELOG.md with the latest release details
|
| 22 | 1. Compile the docs (details in the package.json - unless it's a very small change)
|
| 23 | 1. Push the changes to Github and wait for tests to pass in CI
|
| 24 | 1. Push the changes to NPM with `npm publish`
|
| 25 | 1. Update any related content in the [Github wiki](https://github.com/ActiveCampaign/postmark.js/wiki)
|
| 26 | 1. Add release version in the [Github releases](https://github.com/ActiveCampaign/postmark.js/releases) so it has a tag.
|