-
Notifications
You must be signed in to change notification settings - Fork 10
Release playbook
Travis Carden edited this page Jun 20, 2024
·
15 revisions
- Before committing to a release...
- Check the issue queue for critical issues.
- Search the codebase for important
@todo
comments.
- Make sure your local branches are current.
- Run automated tests with
composer all
. - Make sure any needed documentation changes have been made--in the codebase and in the Wiki.
- Create a release tag. (See Branching & versioning.)
- Choose a semantic version number (
x.y.z
). - Start the release with
git flow release start x.y.z
. - If the release is a new major version (e.g.,
v1.0.0
), update the branch alias atcomposer.json:extra.branch-alias.dev-develop
accordingly. - Finish the release with
git flow release finish x.y.z
. Accept the default commit messages, e.g.,Merge branch 'release/1.0.0'
andv1.0.0
. - Push the release tag to GitHub along with the updated
develop
andmain
branches. - Wait for CI tests to pass.
- Choose a semantic version number (
- Create a GitHub release using the "Generate release notes" button to set the title and description.
- Update the package at https://packagist.org/packages/php-tuf/composer-stager to publish the new release. Delete any extraneous versions it may create, e.g.,
dev-feature/example
.