Skip to content

bump install snippet versions in draft-release workflow - #78

Open
Rabsztok wants to merge 1 commit into
mainfrom
draft-release-bump-version-refs
Open

Rabsztok wants to merge 1 commit into
mainfrom
draft-release-bump-version-refs

Conversation

@Rabsztok

@Rabsztok Rabsztok commented Sep 29, 2026 •

Copy link
Copy Markdown
Member

Motivation

The draft-release workflow only bumps pom.xml, so the install snippets in the docs fall behind with every release. The README needed a manual fix in #74, and docs/getting-started.md (published to GitHub Pages) still says 1.3.0. Follow-up to #74 (review), same approach as the mailtrap-dotnet draft-release workflow.

Changes

  • add a draft-release step that sets the next version in the Maven (<version> inside the mailtrap-java dependency) and Gradle (io.mailtrap:mailtrap-java:X.Y.Z) snippets in README.md and docs/getting-started.md; open-sdk-release-pr commits them through git commit -am
  • bump docs/getting-started.md from 1.3.0 to 1.7.0

No other files mention the version: the User-Agent header has no version in it, and CHANGELOG.md is already updated by prepend-changelog.

How to test

  • run the new step with GNU sed (ubuntu:24.04, NEXT=1.8.0): all six snippets in README.md and docs/getting-started.md change to 1.8.0 and nothing else changes
  • actionlint .github/workflows/draft-release.yml passes
  • on the next draft-release run, the release PR diff includes README.md and docs/getting-started.md

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the Maven, Gradle Groovy, and Gradle Kotlin dependency examples to use mailtrap-java version 1.7.0.
    • Install snippets in the README and getting-started guide are updated to match the next release version when release notes are available.

The draft-release workflow bumped only pom.xml, so the Maven/Gradle
install snippets in README.md and docs/getting-started.md went stale
(README needed a manual fix in #74, the docs page still said 1.3.0).
Add a sed step, mirroring mailtrap-dotnet, that rewrites both snippet
shapes to the next version; the release PR action commits them via
`git commit -am`. Also bring docs/getting-started.md up to 1.7.0.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Sep 29, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 7da3810f-9ecd-4bfe-b8c3-6a11f8cbda36

📥 Commits

Reviewing files that changed from the base of the PR and between b4e5fca and 6819df9.

📒 Files selected for processing (2)
  • .github/workflows/draft-release.yml
  • docs/getting-started.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The getting-started Maven and Gradle examples now use version 1.7.0. When release notes are nonempty, the release workflow updates matching dependency versions in README.md and docs/getting-started.md to the computed next version.

Changes

Release snippet version updates

Layer / File(s) Summary
Documented versions and release automation
.github/workflows/draft-release.yml, docs/getting-started.md, README.md
The getting-started dependency examples use version 1.7.0. When release notes are nonempty, the workflow updates matching dependency versions in README.md and docs/getting-started.md to the computed next version.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Feature

Suggested reviewers: igordobryn

Merge Risk: ⚪ Minimal · up to 6819d

The current README and getting-started examples are updated to the release version; no actionable merge risk was identified.

Architecture Summary

Architecture risk: 🔵 Low · up to 6819d

The change affects 1 system.

Changed systems: docs

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in docs/getting-started.md: The Maven dependency example version changes from 1.3.0 to 1.7.0.
  • observed — Modified behavior in docs/getting-started.md: The Gradle Groovy dependency example version changes from 1.3.0 to 1.7.0.
  • observed — Modified behavior in docs/getting-started.md: The Gradle Kotlin DSL dependency example version changes from 1.3.0 to 1.7.0.
  • observed — Modified behavior in .github/workflows/draft-release.yml: The workflow comment now says the release process also bumps versions in the README and getting-started install snippets.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: updating install snippet versions in the draft-release workflow.
Description check ✅ Passed The description includes the required Motivation, Changes, and How to test sections. It explains the workflow change, documentation update, and planned validation. The optional Images and GIFs section…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants