Skip to content

docs: add branch structure and release process to CLAUDE.md#1844

Merged
gnodet merged 1 commit into
masterfrom
add-claude-md
Apr 27, 2026
Merged

docs: add branch structure and release process to CLAUDE.md#1844
gnodet merged 1 commit into
masterfrom
add-claude-md

Conversation

@gnodet
Copy link
Copy Markdown
Member

@gnodet gnodet commented Apr 27, 2026

Summary

  • Documents the branch structure (master, 4.0.x, jline-3.x) and their purposes
  • Documents the release process for both 4.x (tag-push) and 3.x (workflow_dispatch)
  • Documents build wrapper differences between branches
  • Documents backporting workflow

Summary by CodeRabbit

  • Documentation
    • Updated documentation with a new "Branches and Releases" section providing comprehensive guidance on maintenance branch responsibilities for managing releases, build process mappings, version-specific release workflows with both automated tag-driven and manual input-driven execution procedures, and detailed backporting processes including cherry-picking, CI validation, branch merging, and release execution steps.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 27, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5bc35b36-e3dd-4afb-8e1d-1ee7d84c2187

📥 Commits

Reviewing files that changed from the base of the PR and between bad4549 and 57d2211.

📒 Files selected for processing (1)
  • CLAUDE.md

📝 Walkthrough

Walkthrough

Adds a new "Branches and Releases" section to CLAUDE.md documenting maintenance branch roles for 4.x versus 3.x versions, mapping branches to build wrapper scripts, and specifying release procedures including tag-driven workflows for 4.x and workflow_dispatch-driven workflows for 3.x, plus a backporting process.

Changes

Cohort / File(s) Summary
Documentation
CLAUDE.md
Added "Branches and Releases" section detailing maintenance branch organization, build wrapper script mappings, version-specific release workflows (tag-driven for 4.x, workflow_dispatch for 3.x), and cherry-pick backporting procedures.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 Branches and releases, now plain as can be,
Four-x and three-x workflows, for all eyes to see,
With tags and dispatches, each path shines so bright,
Documentation's the magic that makes future sprints light!

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch add-claude-md

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 and usage tips.

@gnodet gnodet merged commit 35b6f02 into master Apr 27, 2026
13 of 14 checks passed
@sonarqubecloud
Copy link
Copy Markdown

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant