Repository navigation
docs(adr): record ecosystem-enablement and required-LLM-model decisions - #566
Merged
Merged
Conversation
ADR-0004 captures the "detection enables, config opts out" ecosystem-enablement model (#554); ADR-0005 captures shipping no LLM model defaults and requiring an explicit llm.model (#541). Both are decisions someone will otherwise re-litigate — "why does cargo publish by default?" and "let's add model defaults for convenience" — so the durable why belongs in an ADR. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011i1KvoyxATU3bz5V5Sf1Xu
Contributor
|
Standing release PR: #555 · v0.40.1 queued (4 packages) · open 3h 8m · ✅ 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 |
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.
Two ADRs capturing decisions made in the 0.41.0 work that someone will otherwise re-litigate. Kept as a standalone docs PR (rather than folding into #563/#564) to avoid more stacked-rebase churn and to keep the decisions reviewable on their own.
ADR-0004 — Ecosystem enablement: detection enables, config opts out
The durable why behind #554. Every detected ecosystem is versioned and (where publishing is configured and authenticated) published by default; config is only ever an opt-out, with two independent per-ecosystem toggles (
version.<eco>.enabled,publish.<eco>.enabled). Records why default-on is safe (the pipeline fails safe structurally) and why the crates.io/pub.dev default flip is an acceptable breaking change. Answers the inevitable "why does cargo publish by default?"ADR-0005 — Require an explicit LLM model; ship no defaults
The durable why behind #541's pivot. releasekit ships no model ids (they rot — the openai default we nearly shipped,
gpt-4o-mini, was already deprecated);llm.modelis required and validated at config load,provideris a closed enum, and CLI-assembled configs go through the same schema so misconfig fails loud. Answers the inevitable "let's add model defaults for convenience."Both follow the existing Nygard format (Context / Decision / Consequences), are indexed in
docs/adr/README.md, and link their implementing issues. No code changes.Greptile Summary
This PR adds two Architecture Decision Records capturing design decisions made during the 0.41.0 release cycle, with no code changes.
llm.modeland ship zero model-id defaults, because shipped defaults rot as providers deprecate model ids; the ADR also notes that CLI-assembled configs are validated through the same schema so misconfiguration fails loud.Confidence Score: 5/5
Documentation-only change; no executable code is modified.
Both ADRs follow the existing Nygard format, are correctly numbered and indexed in the README, and accurately describe the design decisions and their trade-offs — including the breaking-change implications of flipping crates.io/pub.dev publish defaults and the UX cost of dropping zero-config Ollama. Nothing here affects runtime behaviour.
No files require special attention.
Important Files Changed
Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A[Ecosystem detected] --> B{publish configured\n& authenticated?} B -- Yes --> C[version.eco.enabled\ndefault: true] B -- No --> D[no-op / skip at auth check] C -- false --> E[Skip versioning\nand publishing] C -- true --> F[Version manifests] F --> G{publish.eco.enabled\ndefault: true} G -- false --> H[Version & tag only\ne.g. publish elsewhere] G -- true --> I[Publish to registry] style E fill:#f9c,stroke:#c66 style H fill:#ffc,stroke:#aa0 style I fill:#cfc,stroke:#060 style D fill:#eee,stroke:#999%%{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[Ecosystem detected] --> B{publish configured\n& authenticated?} B -- Yes --> C[version.eco.enabled\ndefault: true] B -- No --> D[no-op / skip at auth check] C -- false --> E[Skip versioning\nand publishing] C -- true --> F[Version manifests] F --> G{publish.eco.enabled\ndefault: true} G -- false --> H[Version & tag only\ne.g. publish elsewhere] G -- true --> I[Publish to registry] style E fill:#f9c,stroke:#c66 style H fill:#ffc,stroke:#aa0 style I fill:#cfc,stroke:#060 style D fill:#eee,stroke:#999Reviews (1): Last reviewed commit: "docs(adr): record ecosystem-enablement a..." | Re-trigger Greptile