Skip to content

Releasing Versioning

Luke Walsh edited this page Dec 18, 2022 · 1 revision

Versioning

This package follows symver where possible; v[Major].[Minor].[Patch].

  • Patch - Reserved for bugfixes, small patches to existing functionality that does not have breaking changes
  • Minor - Reserved for minor additions or changes that does not have breaking changes
  • Major - Reserved for major additions or changes that may have breaking changes

Releasing

  1. Update CONTRIBUTORS.txt, commit if changes
  2. Confirm Actions and build passes
  3. Modify the Changelog wiki and indicate all applicable changes
  4. Modify the Upgrading wiki and provide a guide on upgrading to to next version, only if applicable
  5. Draft a new release within Github with the next version as the title and changelog entry for the body
  6. Publish the release (this will automatically update Packagist/Composer entry)
  7. If a major or minor release... create a branch for the version if it does not exist; example: if v16.2.0 was released, you would perform git checkout -b 16.1 v16.1.0 && git push origin 16.1
  8. If a patch release... create a PR to version branch; example: if v16.2.1 is what you're releasing, create a PR to branch 16.2 to keep it updated
  9. Done!