diff --git a/README.md b/README.md index 18ba223..99beec1 100644 --- a/README.md +++ b/README.md @@ -36,24 +36,4 @@ Specifically, the [Ruby integration](https://posthog.com/docs/integrations/ruby- 1. Run `bin/test` (this ends up calling `bundle exec rspec`) 2. An example of running specific tests: `bin/test spec/posthog/client_spec.rb:26` -## How to release - -Both `posthog-ruby` and `posthog-rails` are released together with the same version number. - -1. Create a PR that: - - Updates `lib/posthog/version.rb` with the new version - - Updates `CHANGELOG.md` with the changes and current date - -2. Add the `release` label to the PR - -3. Merge the PR to `main` - -4. The release workflow will: - - Notify the Client Libraries team in Slack - - Wait for approval via the GitHub `Release` environment - - Publish both gems to RubyGems (via trusted publishing) - - Create and push a git tag - -5. Approve the release in GitHub when prompted - -The workflow handles publishing both `posthog-ruby` and `posthog-rails` in the correct order (since `posthog-rails` depends on `posthog-ruby`). +For release instructions, see [RELEASING.md](RELEASING.md). diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 0000000..8c84322 --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,21 @@ +# Releasing + +Both `posthog-ruby` and `posthog-rails` are released together with the same version number. + +1. Create a PR that: + - Updates `lib/posthog/version.rb` with the new version + - Updates `CHANGELOG.md` with the changes and current date + +2. Add the `release` label to the PR + +3. Merge the PR to `main` + +4. The release workflow will: + - Notify the Client Libraries team in Slack + - Wait for approval via the GitHub `Release` environment + - Publish both gems to RubyGems (via trusted publishing) + - Create and push a git tag + +5. Approve the release in GitHub when prompted + +The workflow handles publishing both `posthog-ruby` and `posthog-rails` in the correct order (since `posthog-rails` depends on `posthog-ruby`).