This is the guide for maintainers:
# Release Process
- Pull the latest changes from main branch for release stream e.g. 3.x
- Create a release branch and switch to it by npm run prepare-release
- Verify version in package.json
- Go through the commits for the new release that technically printed on the console log at step 2 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 #123a 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.
- Run ./runok.js docsto build documentation
- Commit all changes, push and create a PR
- Check that all tests pass and merge your PR, ref PR -> https://github.com/codeceptjs/CodeceptJS/pull/4853
- Run ./runok.js releaseto 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
- Post announcements in Twitter & Slack
# Updating the website
- Run ./runok.js docs:helpersto build docs from helpers
- Run ./runok.js publish:siteto update a website