Skip to content

docs: add ADR-019 re-evaluating release automation (research record) - #195

Draft
hasansezertasan wants to merge 1 commit into
mainfrom
research-release-automation-history
Draft

docs: add ADR-019 re-evaluating release automation (research record)#195
hasansezertasan wants to merge 1 commit into
mainfrom
research-release-automation-history

Conversation

@hasansezertasan

Copy link
Copy Markdown
Owner

Summary

Adds ADR-019 as a research record re-evaluating the release-automation tooling chosen in ADR-002 (release-please) and refined in ADR-004 (Commitizen as commit helper). Status is Proposed — under discussion; no decision made — the ADR deliberately records options without selecting one.

Motivated by two pain points plus general release-PR-model friction:

  1. RC → stable changelog range — a final stable cut after RCs only lists changes since the last RC, not the last stable.
  2. Stale draft-release comment link — the accepted untagged-<hash> cosmetic limitation from release-please "Created releases" comment links to a dead untagged-… draft URL after finalize-release publishes #143 / docs: document stale untagged release-comment link as accepted limitation #152.

What the ADR records

  • Context — release-please's five responsibilities and the ~11-job release_created/tag_name/version gating contract; the draft dance and phantom-PR reconciliation.
  • Conceptual frame — commit helper vs changelog engine vs release orchestrator, and why both pain points are artifacts of release-please's specific model.
  • Research method + honest caveats — two adversarially-verified deep-research passes (primary sources), including that pass 2's synthesis step failed on a usage limit after the claims were already verified.
  • Findings — full candidate landscape (release-please, Commitizen, Python Semantic Release, cocogitto, knope, git-cliff, semantic-release, changesets, hatch-regex-commit) with per-pain-point verdicts and primary-source citations (incl. the npm-team manual-workaround quote, Commitizen v4.11.3 changelog_merge_prerelease fix, PSR source-code trace, git-cliff #1380).
  • Deep comparison — git-cliff vs Commitizen as replacements, with migration shape, config sketch, and an effort/fit table.
  • Options (stay+document / migrate to Commitizen / git-cliff orchestrator / defer), decision drivers, open questions, per-option consequences, and a grouped source appendix.

Notes

Verification

  • markdownlint-cli2 passes on the new ADR
  • typos passes on the new ADR

@coderabbitai

coderabbitai Bot commented Aug 10, 2026

Copy link
Copy Markdown

Important

Review skipped

Draft detected.

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

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 6afdcd0a-dd1f-4d65-a1df-93d5adfabff9

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

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.

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.

1 participant