docs(adr): align ADR-0019's test list with the suite - #56
Open
gosharplite wants to merge 1 commit into
Open
gosharplite wants to merge 1 commit into
gosharplite wants to merge 1 commit into
Conversation
The Consequences section cited TestRefresh_ADORepinDropsTheRecordedType, which does not exist, and omitted three tests that pin decisions the ADR records. Replace the phantom citation with the re-pin tests that actually exist and add the omitted tests (ref-type recorded only where needed, a header without the key resolved on refresh, and the batch stopping on an unusable CLI). Fixes stacklok#53 Signed-off-by: blevins darrin <darrinb765@gmail.com>
gosharplite
marked this pull request as ready for review
September 27, 2026 10:03
This branch has not been deployed
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
2 participants
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.
Fixes #53.
The Consequences section of
project-docs/adr/0019-azure-devops-as-a-second-transport.mdcited a test that does not exist and omitted three that pin decisions the ADR records.TestRefresh_ADORepinDropsTheRecordedType— not in the suite.TestRefresh_ADORepinRetypesTheRef,TestRefresh_ADORepinToACommitTypesItAsACommit.TestADR_0019_RefTypeIsRecordedOnlyWhereItIsNeeded,TestRefresh_ADOHeaderWithoutRefTypeResolvesIt,TestSurvey_ResolutionAbortsOnUnusableCLI.Each name in the corrected paragraph was checked against
go test ./internal/deps/ -list '.*'; the only remaining multi-name entries are the intentionalTestImport_ADO_*andTestTimeoutRunner_*globs (plusTestSchemaStructSync, which lives in another package and is cited as not in play).Supersede-vs-edit
This edits ADR-0019 in place rather than superseding it. Issue #53's "editing it in place is fine" note was written when ADR-0019 was unmerged, but it has since landed on
main(via #52), so.claude/rules/adr.md's "decisions are never edited in place" now applies on its face. This change corrects a stale factual citation — it alters no decision ADR-0019 records — so it is an in-place correction, not a re-decision. Flag if you'd prefer a superseding ADR instead.Root cause (follow-up, not touched here)
The phantom citation has a source:
internal/deps/refresh_test.go:578-582carries an orphaned doc comment naming the non-existentTestRefresh_ADORepinDropsTheRecordedType, stacked immediately above the realTestRefresh_ADORepinRetypesTheRef(which has its own correct comment below it). The ADR's bad citation and this comment name the same phantom test, so the comment is where the name entered the record.It is pre-existing on
mainand outside this PR's diff — #56 fixes the ADR that cited the name, not the test file that spawned it, so the change stays docs-only. Removing the stale comment block is a one-line cleanup the maintainer can take up here or in a follow-up, as they prefer.Docs-only change; no code touched.