Release Process

This is the guide for maintainers:

Release Process

1. Pull the latest changes from main branch for release stream e.g. 3.x
2. Create a release branch and switch to it by npm run prepare-release
3. Verify version in package.json
4. Go through the commits for the new release and add them to the CHANGELOG.md:

• Changelog should be written for humans (not for robots).
• Use simple wording explaining what the change is, how to use a new feature (maybe with a code example) and mention the related issue.
• When using #123 a link for issue #123 will be automatically added.
• A contributor must be mentioned. We use GitHub names with @ prefix. A link to user profile is automatically added.

5. Run ./runok.js docs to build documentation
6. Commit all changes, push and create a PR
7. Check that all tests pass and merge your PR
8. Run ./runok.js release to publish latest release. The website will be updated.

• To update version for patch release: ./runok.js release patch
• To update version for minor release: ./runok.js release minor

9. Post announcements in Twitter & Slack

Updating the website

• Run ./runok.js docs:helpers to build docs from helpers
• Run ./runok.js publish:site to update a website