Skip to content

Commit 88e2879

Browse files
committed
chore: remove legacy release tooling and document new flow
Deletes the old release_gem.yml workflow, trigger scripts, and RELEASING.md. Updates DEVELOPING.md with a Releasing section describing the new draft PR → merge → tag → publish flow. Assisted-by: Claude Code:claude-sonnet-4-6
1 parent e9b53cd commit 88e2879

6 files changed

Lines changed: 16 additions & 120 deletions

File tree

.github/workflows/release_gem.yml

Lines changed: 0 additions & 70 deletions
This file was deleted.

DEVELOPING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,19 @@
1515
## Generating docs
1616

1717
If you change the CLI commands, run `bundle exec script/update-cli-usage-in-readme.rb` to update the `README.md` automatically.
18+
19+
## Releasing
20+
21+
Releases are fully automated via the PR-driven flow in `.github/workflows/release.yml`.
22+
23+
1. **On every push to `master`**, the `prepare` job runs `scripts/release.rb prepare`, which uses git-cliff to compute the next semver, updates `lib/pact_broker/client/version.rb` and `CHANGELOG.md`, force-pushes the changes to the `release/pact-broker-client` branch, and creates or updates a **draft** release PR.
24+
25+
2. **When ready to release**, promote the PR from draft → ready-for-review. This triggers CI. You can edit `version.rb` or `CHANGELOG.md` directly on the `release/pact-broker-client` branch to make manual adjustments — those files are the source of truth.
26+
27+
3. **Merging the PR** triggers the `tag` job, which reads the version from `version.rb` and pushes a `v{version}` tag.
28+
29+
4. **The tag push** triggers the `publish` job: runs tests, builds the gem, creates a GitHub Release, and pushes to RubyGems via OIDC (no stored API key required).
30+
31+
### One-time setup (already done once per gem)
32+
33+
Configure OIDC trusted publishing on [rubygems.org](https://rubygems.org) for the `pact_broker-client` gem, trusting the `publish` job in `pact-foundation/pact_broker-client`.

RELEASING.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

script/ci/record-release.sh

Lines changed: 0 additions & 7 deletions
This file was deleted.

script/release.sh

Lines changed: 0 additions & 9 deletions
This file was deleted.

script/trigger-release.sh

Lines changed: 0 additions & 30 deletions
This file was deleted.

0 commit comments

Comments
 (0)