phppdf Docs

Organization-wide documentation for the phppdf projects

Source ↗

Documentation

Release process

phppdf projects follow Semantic Versioning (MAJOR.MINOR.PATCH).

Versioning

  • MAJOR — breaking changes to the public API.
  • MINOR — new, backwards-compatible functionality.
  • PATCH — backwards-compatible bug fixes.

Before tagging a release

  1. Make sure master is green: the full test suite and coding standard checks pass in CI.
  2. Update the changelog with the notable changes since the last release.
  3. Bump the version where it’s recorded (e.g. a CHANGELOG.md entry).

Tagging

Releases are tagged on master using an annotated, signed tag:

git tag -s vX.Y.Z -m "vX.Y.Z"
git push origin vX.Y.Z

Packagist picks up new tags automatically for projects registered there, via the GitHub webhook.

Supported versions

Only the latest MAJOR version of a project receives new features. Security fixes and critical bug fixes may be backported to the previous MAJOR version at the maintainers’ discretion.