K1bs/automate release

[k1bs]

No description provided.

[coderabbitai]

Caution

Review failed

The head commit changed during the review from 790630e to 31339d6.

Walkthrough

A new GitHub Actions release workflow is introduced to automate gem publishing to RubyGems, while README installation instructions are simplified by removing GitHub and placeholder installation options.

Changes

Cohort / File(s)	Summary
GitHub Actions Release Workflow .github/workflows/release.yml	New workflow triggered on release publication. Executes tests, builds gem artifact, and pushes to RubyGems using API key from secrets.
Documentation README.md	Removed "Install from GitHub" and "Or from RubyGems (once published)" sections, leaving only standard gem installation instructions.

Sequence Diagram

sequenceDiagram
    actor GitHub
    participant GHA as GitHub Actions
    participant Bundler
    participant RSpec
    participant GemBuild as Gem Builder
    participant RubyGems

    GitHub->>GHA: Release published event
    GHA->>GHA: Checkout code
    GHA->>Bundler: Setup Ruby 3.2
    Bundler->>RSpec: Install dependencies
    RSpec->>RSpec: Run tests (bundle exec rspec)
    RSpec-->>GHA: Tests passed
    GHA->>GemBuild: Build gem (gem build data_nexus.gemspec)
    GemBuild-->>GHA: Gem artifact created
    GHA->>RubyGems: Push gem with API key
    RubyGems-->>GHA: Gem published

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	No pull request description was provided by the author, making it impossible to assess relevance to the changeset.	Add a description explaining the purpose and scope of the automated release workflow and documentation changes.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'K1bs/automate release' is directly related to the changeset which adds automated release workflow and updates documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch k1bs/automate-release

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In @.github/workflows/release.yml:
- Around line 23-27: Add a guard step before the "Build gem" step that reads the
gem version from data_nexus.gemspec (e.g., using a small Ruby one-liner or grep)
and compares it to github.event.release.tag_name, and fail the job if they don't
match; implement this check as a new workflow step (e.g., "Verify release tag
matches gemspec") placed prior to running "Build gem" and "Push to RubyGems" so
the pipeline stops on mismatch.
- Around line 23-27: The workflow currently uses a wildcard in the "Push to
RubyGems" step (run: gem push data_nexus-*.gem) which can select the wrong
artifact; modify the "Build gem" step (run: gem build data_nexus.gemspec) to
capture the exact filename produced (e.g., parse the build output or list the
created file) and expose it as an output or environment variable, then update
the "Push to RubyGems" step to push that explicit filename (use the captured
variable instead of data_nexus-*.gem) so only the intended gem artifact is
uploaded.

🧹 Nitpick comments (1)

.github/workflows/release.yml (1)

12-18: Consider pinning GitHub Actions to commit SHAs.
This improves supply-chain integrity for release publishing workflows.

[fastjames]

👏