RELEASE_CHECKLIST.md

Release Checklist

Preparation

• Ensure all tests are passing (including Travis and StyleCI).
• Ensure changes are documented in CHANGELOG.md. Release titles should be linked to Github.
• If breaking changes or deprecations are introduced, document the upgrade process in the doc site's upgrade page.
• Bump the branch-alias in composer.json and the dev VERSION in CommonMarkConverter if needed.
• Ensure all changes above make it into the latest branch

Documentation

• Update the relevant documentation in ./docs/
• Remember to note the upgrade changes in the docs too
• If releasing a new major or minor version, make sure to clone the previous one and make the necessary changes. This will allow people to submit new features to the dev-latest version. Don't forget to update version numbers in project.yml! And update the redirects too. Especially for /security/.
• Build and preview the docs locally

Release

• Create a new release branch.
• Update the CommonMarkConverter::VERSION constant and commit just that one change to that release branch. Make sure tests still pass.
• Create a signed tag locally and push it up. Tag should be named xx.yy.zz.
• Go to Github and add release notes from the relevant CHANGELOG section.
• Resync project on https://libraries.io/packagist/league%2Fcommonmark/
• Update release notes and supported branches on Tidelift
• ???
• PROFIT!!