Skip to content

RELEASE_CHECKLIST.md

Latest commit

 

History

History
15 lines (13 loc) · 884 Bytes

RELEASE_CHECKLIST.md

File metadata and controls

15 lines (13 loc) · 884 Bytes

Release Checklist

  • 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 UPGRADE.md.

  • Update the compatibility section in README.md.

  • Bump the branch-alias in composer.json if needed.

  • Ensure all changes above make it into the master branch

  • 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 release in Github BASED ON THE RELEASE BRANCH, NOT MASTER!; tag should be named xx.yy.zz. Copy CHANGELOG section into release notes.

  • Remove that release branch once tagged

  • ???

  • PROFIT!!