Document the release process in the README - #214
Merged
rvanbaalen merged 1 commit intoSep 11, 2026
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a Releasing section to the README. It describes the release process as it exists today. No tooling changes.
Why
Nothing in the repo said how to cut a release. v5.3.1 never reached Packagist because
composer.jsonhad a hard-codedversionfield, and it had to be re-tagged as v5.3.2. Writing the steps down prevents a repeat.The documented steps
master, tests green.composer.jsonhas noversionfield.vX.Y.Ztag.Packagist and the docs site update on their own after that.
Review
Read the new section in
README.mdunder "Releasing". About 2 minutes.