RELEASING.md

Releasing

Releases are semi-automated via GitHub Actions. When a PR with the release and a version bump label is merged to main, the release workflow is triggered. You can also trigger the Release workflow manually from GitHub Actions and choose the bump type.

You'll need an approval from a PostHog engineer. If you're an employee, you can see the request in the #approvals-client-libraries channel.

Release Process

1. Either:
   • Create your PR with the changes you want to release, add the release label, add exactly one version bump label (bump-patch, bump-minor, or bump-major), and merge the PR to main, or
   • open the Release workflow in GitHub Actions, click Run workflow, and choose patch, minor, or major

Once the workflow is triggered, the following happens automatically:

1. A Slack notification is sent to the client libraries channel requesting approval
2. A maintainer approves the release in the GitHub Release environment
3. The version is bumped in lib/PostHog.php and composer.json based on the version label (patch, minor, or major, extracted from the label)
4. The CHANGELOG.md is updated with a link to the full changelog
5. Changes are committed and pushed to main
6. A git tag is created (e.g., v1.8.0)
7. A GitHub release is created with the changelog content
8. Slack is notified of the successful release

Releases are installed directly from GitHub.