Repository navigation
ci: Configure release please - #103
Merged
Merged
Conversation
Add release-please (manifest mode, ruby release type) to manage version bumps, CHANGELOG.md, tags and GitHub releases, starting from v4.5.0. - release-please workflow opens/updates the release PR on pushes to main, re-locks Gemfile.lock and the Appraisal lockfiles on the release branch, and publishes the gem when a release is created. - build_publish accepts `ref` and `publish` inputs so it can be called from the release workflow (tags created with GITHUB_TOKEN do not trigger CI). - Replace the "changelog must be edited" check with a Conventional Commits PR title check. - Remove the hand-maintained Unreleased section from CHANGELOG.md, as release-please inserts new entries above the first version heading. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Pushes made with GITHUB_TOKEN don't trigger workflows, so the required status checks never reported on release-please PRs. workflow_dispatch events are exempt from that rule, so have the release workflow dispatch CI against the release branch once the lockfiles are updated. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Test coverage: 100.0% |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The release documentation contains conflicting guidance and assumes an incorrect first automated version.
2 open findings
What changed in this PR
Configures automated gem releases with release-please, including versioning, changelog generation, lockfile updates, validation, and publishing.
Changes:
- Adds release-please configuration and release workflow.
- Enforces Conventional Commit PR titles and dispatches release-branch CI.
- Updates publishing and release documentation.
| File | Description |
|---|---|
release-please-config.json |
Configures Ruby releases. |
.release-please-manifest.json |
Establishes version 4.5.0 baseline. |
.github/workflows/release-please.yml |
Automates releases, lockfiles, CI, and publishing. |
.github/workflows/pr_title.yml |
Validates Conventional Commit titles. |
.github/workflows/ci.yml |
Enables manual CI dispatch. |
.github/workflows/build_publish.yml |
Supports publishing a specified ref. |
.github/workflows/changelog.yml |
Removes manual changelog enforcement. |
README.md |
Documents the automated release process. |
CHANGELOG.md |
Marks the changelog as automation-managed. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Explain that the PR title and description become the squash-merge commit message, list all release-producing types, and remove the outdated instruction to update version.rb by hand. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Update the example tag to v4.5.0 and wrap it in release-please version markers, with README.md listed in extra-files, so each release PR updates it automatically. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
carlospena-irysan
approved these changes
Oct 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Set up release-please to manage versioning, the changelog, tags and releases, starting from v4.5.0.
PR titles must now follow Conventional Commits. Each push to
mainupdates a release PR. Merging that PR tags the release and publishes the gem.Changes
release-please.ymlworkflow. It updates the lockfiles on the release PR, runs CI so that the required check reports, and publishes the gem when a release is created.refandpublishinputs tobuild_publish.yml, and aworkflow_dispatchtrigger toci.yml.[Unreleased]fromCHANGELOG.mdand update the "Releasing" section of the README.Notes
feat:orfix:commit is merged intomain.