Skip to content

docs(changelog): remove How to Release prose section (#567)#576

Merged
nanotaboada merged 1 commit intomasterfrom
docs/normalize-changelog-567
Apr 22, 2026
Merged

docs(changelog): remove How to Release prose section (#567)#576
nanotaboada merged 1 commit intomasterfrom
docs/normalize-changelog-567

Conversation

@nanotaboada
Copy link
Copy Markdown
Owner

@nanotaboada nanotaboada commented Apr 21, 2026

Summary

  • Removes the ## How to Release prose block (numbered steps, tag format examples, CD workflow description, and pre-release checklist)
  • Keeps the <!-- Template for new releases: --> comment and all reference links unchanged

Closes #567

Test plan

  • CHANGELOG.md no longer contains ## How to Release
  • Template comment and reference links at the bottom are intact
  • No other content changed

🤖 Generated with Claude Code


This change is Reviewable

Summary by CodeRabbit

  • Documentation
    • Simplified changelog documentation by removing release process guidelines.

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 21, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: e00c550e-2e65-408f-bfa7-662d91e25b00

📥 Commits

Reviewing files that changed from the base of the PR and between c270f8f and d58c988.

📒 Files selected for processing (1)
  • CHANGELOG.md
💤 Files with no reviewable changes (1)
  • CHANGELOG.md

Walkthrough

This PR removes the "How to Release" section from CHANGELOG.md, including step-by-step release instructions, tag format examples, CD workflow description, and pre-release checklist, while preserving the release template comment and reference links.

Changes

Cohort / File(s) Summary
Documentation Cleanup
CHANGELOG.md
Removed "How to Release" prose block containing release steps, tag format examples, CD workflow description, and pre-release checklist (43 lines deleted). Retained template comment and reference links.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Assessment against linked issues

Objective Addressed Explanation
Remove ## How to Release prose block [#567]
Keep <!-- Template for new releases: --> comment in place [#567]
Keep reference links at the bottom unchanged [#567]
No other content changed [#567]

Possibly related issues

Possibly related PRs

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title uses Conventional Commits format (docs:), is descriptive and specific about the change, is under 80 characters (59 total), and clearly summarizes the main changeset.
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 unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/normalize-changelog-567
  • 🛠️ sync documentation: Commit on current branch
  • 🛠️ sync documentation: Create PR
  • 🛠️ enforce http error handling: Commit on current branch
  • 🛠️ enforce http error handling: Create PR
  • 🛠️ idiomatic review: Commit on current branch
  • 🛠️ idiomatic review: Create PR
  • 🛠️ verify api contract: Commit on current branch
  • 🛠️ verify api contract: Create PR

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.

@sonarqubecloud
Copy link
Copy Markdown

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 21, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (c270f8f) to head (d58c988).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #576   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            7         7           
  Lines          172       172           
=========================================
  Hits           172       172           

☔ View full report in Codecov by Sentry.
📢 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@nanotaboada
Copy link
Copy Markdown
Owner Author

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 22, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@nanotaboada nanotaboada merged commit 361eb3a into master Apr 22, 2026
11 checks passed
@nanotaboada nanotaboada deleted the docs/normalize-changelog-567 branch April 22, 2026 18:55
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.

Normalize CHANGELOG.md structure

1 participant