Skip to content

docs(adr): scope ADR-0005 to LLM-enhanced release notes #568

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
goosewobbler merged 2 commits into from
Jul 19, 2026
Merged

docs(adr): scope ADR-0005 to LLM-enhanced release notes #568

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f3fbc4
docs(adr): scope ADR-0005 to LLM-enhanced release notes
github-actions[bot] Jul 19, 2026
f190ec0
docs(adr): disambiguate the ADR-0005 scoping sentence
github-actions[bot] Jul 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions ...uire-an-explicit-llm-model-no-defaults.md → ...-require-an-explicit-model-no-defaults.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 5. Require an explicit LLM model; ship no defaults
# 5. LLM-enhanced release notes require an explicit model; ship no defaults

Date: 2026-07-19

Expand All @@ -16,7 +16,9 @@ Crucially, there is no zero-config path to protect: LLM enhancement is already a

## Decision

**ReleaseKit ships no model defaults. `llm.model` is required and validated at config load.**
This decision is scoped to LLM-enhanced release notes — the only place ReleaseKit calls a model. Versioning, changelog generation, and publishing are deterministic and LLM-free; this decision does not touch them.

**For LLM-enhanced release notes, ReleaseKit ships no model defaults. When enhancement is enabled, `llm.model` is required and validated at config load.**

- `llm.model` is a required, non-empty string (Zod `z.string().min(1)`) — a missing or empty model fails at config validation, not silently inside the notes soft-fail catch.
- `provider` is a closed Zod enum (`openai | openai-compatible | anthropic | ollama`); `openai-compatible` additionally requires `baseURL`.
Expand Down
2 changes: 1 addition & 1 deletion docs/adr/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ Roadmap sequencing lives in [ROADMAP.md](../../ROADMAP.md); implementation detai
| [0002](./0002-no-mcp-server-cli-is-the-agent-surface.md) | The agent-facing surface is the CLI, not an MCP server | Accepted |
| [0003](./0003-optional-change-file-input.md) | Change files are supported as an optional input, in changesets format | Accepted |
| [0004](./0004-ecosystem-enablement-detection-enables-config-opts-out.md) | Ecosystem enablement: detection enables, config opts out | Accepted |
| [0005](./0005-require-an-explicit-llm-model-no-defaults.md) | Require an explicit LLM model; ship no defaults | Accepted |
| [0005](./0005-llm-enhanced-notes-require-an-explicit-model-no-defaults.md) | LLM-enhanced release notes require an explicit model; ship no defaults | Accepted |
Loading