Skip to content

Document the skip keyword argument of @testitem - #40

Merged
davidanthoff merged 1 commit into
mainfrom
s1-discovery
Aug 13, 2026
Merged

Document the skip keyword argument of @testitem#40
davidanthoff merged 1 commit into
mainfrom
s1-discovery

Conversation

@davidanthoff

Copy link
Copy Markdown
Member

Part of stream S1 (Discovery) of the ReTestItems feature-delta plan — A.10 item 5, "skip as an item kwarg".

What

Documents skip in the @testitem docstring, and adds two examples. The macro itself stays a no-op marker; nothing executable changes in this repo.

Semantics documented:

  • skip accepts a Bool literal or an arbitrary expression evaluating to a Bool.
  • An expression is evaluated in the test process, immediately before the test item would have run. That is the whole point of making skip an item keyword rather than a coordinator-side filter: VERSION < v"1.11" and Sys.iswindows() must see the worker's environment, not the environment that discovered the item (we support --julia-cmd pointing anywhere, and CI matrices routinely run several Julia versions).
  • Defaults to false.

Companion PRs (land in this order)

  1. this PR — TestItems.jl: docstring.
  2. TestItemDetection.jl — parse skip in find_test_detail!, return option_skip.
  3. JuliaWorkspaces.jl — carry option_skip on TestItemDetail, plus stable test item ids.

Execution of skip (TestItemControllers / TestItemApp) is a later wave.

Testing

Pkg.test() green (4/4). No test items exercise the docstring; behaviour is tested in TestItemDetection.jl and JuliaWorkspaces.jl.

🤖 Generated with Claude Code

`skip` accepts either a `Bool` literal or an arbitrary expression. The
expression is evaluated in the *test process*, immediately before the test
item would have run, so checks like `VERSION < v"1.11"` or `Sys.iswindows()`
see the environment the tests actually run in rather than the one that
discovered them. Defaults to `false`.

The macro remains a no-op marker; parsing lands in TestItemDetection.jl and
the value is carried through JuliaWorkspaces.jl.

Part of stream S1 (Discovery) of the ReTestItems feature-delta plan
(A.10 item 5).

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@davidanthoff
davidanthoff marked this pull request as ready for review August 13, 2026 23:16
@davidanthoff
davidanthoff merged commit 70bcc39 into main Aug 13, 2026
16 of 79 checks passed
@davidanthoff
davidanthoff deleted the s1-discovery branch August 13, 2026 23:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant