Skip to content

chore: consolidate release guide into RELEASING.md - #407

Merged
SoulPancake merged 1 commit into
mainfrom
docs/add-releasing-guide
Nov 3, 2026
Merged

SoulPancake merged 1 commit into
mainfrom
docs/add-releasing-guide

Conversation

@SoulPancake

@SoulPancake SoulPancake commented Nov 3, 2026 •

Copy link
Copy Markdown
Member

Renames RELEASE.md to RELEASING.md for a consistent name across repos, folds in the release-please guide, and applies review feedback.

Copilot AI balanced review requested due to automatic review settings November 3, 2026 06:54
@SoulPancake
SoulPancake requested a review from a team as a code owner November 3, 2026 06:54
@coderabbitai

coderabbitai Bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 23dbeceb-fc6f-4b65-b6a3-817492184550

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • Trigger review

Walkthrough

RELEASING.md now describes automated stable releases from main and pre-releases from develop, including release-please steps, versioning rules, and commit conventions.

Changes

Release documentation

Layer / File(s) Summary
Document release workflows
RELEASING.md
The guide explains how to run and review release-please workflows for stable and pre-releases. It documents commit-type changelog categories, version-bump rules, commit-message overrides, and breaking-change notation.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: aaguiarz

Pre-merge checks: Passed 4
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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.
Title check Passed The title "chore: consolidate release guide into RELEASING.md" matches the changeset. The PR adds RELEASING.md, which documents the release-please stable and pre-release workflows, version bumps, chan…
Full details: Title check

Explanation

The title "chore: consolidate release guide into RELEASING.md" matches the changeset. The PR adds RELEASING.md, which documents the release-please stable and pre-release workflows, version bumps, changelog sections, commit overrides, breaking-change markers, and the develop/main branch flow. The title names the main change, the new release guide file. The word "consolidate" suggests merging existing release guides, but the summary and objectives describe only a new RELEASING.md file (+49/-0) with no removed or merged source documents. This wording is slightly broader than the changeset shows, but it is not off-topic.

Finishing Touches
Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

CodeRabbit Verify

  • Run CodeRabbit Verify to test the changes in this pull request.
Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 6ab3f871-5ab7-47ad-817f-716610e74953
Commits

Reviewing files that changed from the base of the PR and between 1ac069b and 462cbb3.

Files selected for processing: 1
  • RELEASING.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.

@codecov-commenter

codecov-commenter commented Nov 3, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 39.34%. Comparing base (1ac069b) to head (311739d).

Additional details and impacted files
@@             Coverage Diff              @@
##               main     #407      +/-   ##
============================================
+ Coverage     39.33%   39.34%   +0.01%     
- Complexity     1330     1331       +1     
============================================
  Files           202      202              
  Lines          7757     7757              
  Branches        912      912              
============================================
+ Hits           3051     3052       +1     
  Misses         4549     4549              
+ Partials        157      156       -1     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The release instructions omit required explicit-version selection, squash-merging for commit overrides, and the release: merge-message prefix, which can cause incorrect versions, unintended release notes, or skipped publishing.

3 open issues
What changed in this PR

Adds a concise release guide for the Java SDK’s existing release-please automation. This is a documentation-only change.

Changes:

  • Describes how to initiate stable releases and pre-releases.
  • Explains version bumps and changelog sections derived from conventional commits.
  • Documents commit overrides and breaking-change markers.
File Description
RELEASING.md Adds instructions for releases, versioning, and changelog customization.

Review effort: Balanced

Comment thread RELEASING.md Resolved
Comment thread RELEASING.md Resolved
Comment thread RELEASING.md Resolved

@coderabbitai coderabbitai Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Fix comments: Fix CodeRabbit comments on this PR

Comment thread RELEASING.md Resolved
Comment thread RELEASING.md Resolved
Comment thread RELEASING.md Resolved

@Siddhant-K-code Siddhant-K-code left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Main issues: no develop branch exists here, and this overlaps RELEASE.md with conflicting guidance. The rest are small clarifications.

Comment thread RELEASING.md Resolved
Comment thread RELEASING.md Resolved
Comment thread RELEASING.md Resolved
Comment thread RELEASING.md Resolved
Comment thread RELEASING.md Resolved
@SoulPancake SoulPancake changed the title chore: add RELEASING.md chore: consolidate release guide into RELEASING.md Nov 3, 2026
@SoulPancake
SoulPancake force-pushed the docs/add-releasing-guide branch from 462cbb3 to 15e8146 Compare November 3, 2026 08:49

@Siddhant-K-code Siddhant-K-code left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocking points are fixed. Still open: the breaking-changes thread (single-commit PRs squash with the commit title, not the PR title).

Comment thread RELEASING.md Resolved
@SoulPancake
SoulPancake force-pushed the docs/add-releasing-guide branch from 15e8146 to 311739d Compare November 3, 2026 14:48
@SoulPancake
SoulPancake added this pull request to the merge queue Nov 3, 2026
Merged via the queue into main with commit bc745c9 Nov 3, 2026
27 checks passed
@SoulPancake
SoulPancake deleted the docs/add-releasing-guide branch November 3, 2026 16:22
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.

4 participants