Skip to content

Commit 84fc69d

Browse files
committed
docs: align README release rules with title-only bump
The Release Process section claimed a "BREAKING CHANGE" mention in the PR body/title forces a major bump. The workflow now derives the bump from the title's `!` marker only and ignores the body. Update the rules accordingly.
1 parent 066cb95 commit 84fc69d

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -352,16 +352,16 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/getstr
352352

353353
Releases use two paths, both handled by `.github/workflows/release.yml`:
354354

355-
- **Default**: automatic release when a PR is merged to `main`/`master`. The PR title (and body) drives the semver bump.
355+
- **Default**: automatic release when a PR is merged to `main`/`master`. The PR title drives the semver bump.
356356
- **Fallback**: manual release via the `Release` workflow's `workflow_dispatch` (admin use). Select a `version_bump` (`patch`/`minor`/`major`). `use_current_version=true` skips the bump and publishes whatever is already in `lib/getstream_ruby/version.rb`.
357357

358358
Automatic semver bump rules:
359359

360360
- `feat:` -> minor
361361
- `fix:` (or `bug:`) -> patch
362-
- `feat!:`, `<type>(scope)!:`, or `BREAKING CHANGE` in the PR body/title -> major
362+
- `feat!:` or `<type>(scope)!:` (the `!` marker) -> major
363363

364-
PRs with any other prefix do not trigger a release.
364+
PRs with any other prefix do not trigger a release. The bump is derived from the PR title only; the body is not scanned, so mentioning "BREAKING CHANGE" in prose does not force a major bump. Use the `!` marker to signal a breaking change.
365365

366366
The release pipeline runs lint (`make format-check && make lint && make security`), the unit suite (`make test`), and all three integration suites (chat, feed, video) on the merged commit before publishing to RubyGems. Each step is idempotent; a failed run can be re-dispatched from the Actions UI.
367367

0 commit comments

Comments
 (0)