Repository navigation
docs(adr): scope ADR-0005 to LLM-enhanced release notes - #568
Merged
Merged
Conversation
The original title and filename ("require an explicit LLM model") read as
a repo-wide policy, when the decision only governs the one place ReleaseKit
calls a model — LLM-enhanced release notes. Versioning, changelog
generation, and publishing are deterministic and untouched.
Rename the file to 0005-llm-enhanced-notes-require-an-explicit-model-no-defaults.md,
retitle accordingly, add a scoping lead sentence to the Decision section,
and update the ADR index. Same decision, sharper framing — not a
supersession.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011i1KvoyxATU3bz5V5Sf1Xu
Contributor
|
Standing release PR: #555 · v0.41.0 queued (4 packages) · open 4h 5m · ✅ ready to merge Release Preview — v0.40.0 → v0.40.1
These changes will be added to the release PR (#555) when merged: Changelogmonorepo 0.40.0 → 0.40.1
After merge — predicted release
Updated automatically by ReleaseKit |
"it does not touch them" had an ambiguous antecedent (nearest singular noun was "a model"); name "this decision" outright. Greptile review nit. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011i1KvoyxATU3bz5V5Sf1Xu
This was referenced Jul 19, 2026
Merged
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Renames and re-scopes ADR-0005 so its title and filename make clear the "explicit model, no defaults" decision applies only to LLM-enhanced release notes — not to ReleaseKit as a whole.
0005-require-an-explicit-llm-model-no-defaults.md→0005-llm-enhanced-notes-require-an-explicit-model-no-defaults.mddocs/adr/README.mdWhy
The bare title "require an explicit LLM model" reads as a repo-wide stance. In fact a model is called in exactly one place — release-notes enhancement, an explicit opt-in. The narrower title/filename prevents that misreading.
Note on ADR immutability
The ADR index states ADRs are immutable once accepted, with changes made by superseding. This is not a decision change — the decision (no defaults;
llm.modelrequired and validated at load) is identical. It's a same-scope title/framing clarification of an ADR merged hours ago in #566, so it's edited in place rather than superseded.🤖 Generated with Claude Code
Greptile Summary
This PR narrows the scope of ADR-0005 by renaming the file and title to make explicit that the "no defaults, explicit model required" decision applies solely to LLM-enhanced release notes, not to ReleaseKit as a whole.
0005-require-an-explicit-llm-model-no-defaults.mdto0005-llm-enhanced-notes-require-an-explicit-model-no-defaults.mdand its title updated to match.docs/adr/README.mdis updated to reflect the new filename and title.Confidence Score: 5/5
Documentation-only change with no impact on runtime behaviour; safe to merge.
The change is a file rename plus a prose addition that brings the ADR title, filename, and Decision section into alignment. No code is touched, no config is modified, and the README index is updated consistently.
No files require special attention.
Important Files Changed
Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A[ReleaseKit] --> B[Versioning] A --> C[Changelog generation] A --> D[Publishing] A --> E[LLM-enhanced release notes] B --> F[Deterministic / LLM-free] C --> F D --> F E --> G{llm.model set?} G -- No --> H[Config validation fails loud] G -- Yes --> I[Enhancement proceeds] style E fill:#f0e6ff,stroke:#9b59b6 style G fill:#f0e6ff,stroke:#9b59b6 style H fill:#fdecea,stroke:#e74c3c style I fill:#e8f8f0,stroke:#2ecc71 style F fill:#eaf4fb,stroke:#3498db%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%% flowchart TD A[ReleaseKit] --> B[Versioning] A --> C[Changelog generation] A --> D[Publishing] A --> E[LLM-enhanced release notes] B --> F[Deterministic / LLM-free] C --> F D --> F E --> G{llm.model set?} G -- No --> H[Config validation fails loud] G -- Yes --> I[Enhancement proceeds] style E fill:#f0e6ff,stroke:#9b59b6 style G fill:#f0e6ff,stroke:#9b59b6 style H fill:#fdecea,stroke:#e74c3c style I fill:#e8f8f0,stroke:#2ecc71 style F fill:#eaf4fb,stroke:#3498dbReviews (2): Last reviewed commit: "docs(adr): disambiguate the ADR-0005 sco..." | Re-trigger Greptile