Document the test item id format - #4
Draft
davidanthoff wants to merge 1 commit into
Draft
Conversation
Ids appear in the results JSON and the JUnit XML and were documented nowhere. Covers what the parts mean, that they are stable under editing, and that an id identifies a test item within its package rather than within a workspace — so two checkouts of one package share an id, and it is the file path that distinguishes them. Also flags that the `path:name` shown in progress output is a display form rather than an id, which reads confusingly now that real ids exist. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
Ids appear in
--results-jsonand--junit-xmland were documented nowhere.Covers what the parts of
MyPkg@a1b2c3d4/test/parsing_tests.jl::parses floatsmean, that ids are stable under editing, and the property that makes them useful across runs: identical in a dev checkout and on a CI runner, and identical on Windows and Linux.Also states the limit plainly — an id identifies a test item within its package, not within a workspace. Two checkouts of the same package produce the same id, deliberately, since they differ only by location and location differs between a developer's machine and CI. The file path is what distinguishes them, in the console output, the
urifield of the JSON results, and the JUnitclassname.One clarification while I was there: the progress output shows
test/test_parsing.jl:parse basics, which is a display form and not an id. That reads confusingly now that real ids exist, so it is called out.Follows julia-vscode/JuliaWorkspaces.jl#257, which introduced the format. VitePress builds clean, dead-link check included.
🤖 Generated with Claude Code