1 | <a href="https://postmarkapp.com">
|
2 | <img src="https://github.com/wildbit/postmark.js/raw/master/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. Merge your branch to master
|
16 | 2. Update version in package.json
|
17 | 3. Compile the latest version (details how to run command are in the package.json)
|
18 | 4. Make sure the tests pass (details how to run them in the package.json)
|
19 | 5. Update CHANGELOG.md with the latest release details
|
20 | 6. Compile the docs (details in the package.json - unless it's a very small change)
|
21 | 7. Push the changes to Github and wait for tests to pass
|
22 | 8. Push the changes to NPM with `npm publish`
|
23 | 9. Update any related content in the [Github wiki](https://github.com/wildbit/postmark.js/wiki)
|
24 | 10. Add release version in the [Github releases](https://github.com/wildbit/postmark.js/releases) so it has a tag.
|