Skip to content

Add interactive usage example #60

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
merged 5 commits into from
Oct 23, 2025
Merged

Add interactive usage example #60

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0c322fa
add interactive test usage example
icweaver Oct 22, 2025
83f46cc
relax
icweaver Oct 22, 2025
b03d438
Add shell alias example + update testset name
icweaver Oct 22, 2025
7eea058
move julia_args from alias to command line
icweaver Oct 22, 2025
e47e70f
Merge branch 'main' into icweaver-usage
icweaver Oct 22, 2025
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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,20 @@ end
runtests(MyModule, ARGS; init_code)
```

### Interactive use

Arguments can also be passed via the standard `Pkg.test` interface for interactive control. For example, here is how we might run the subset of tests that start with the testset name "MytestsetA" in i) verbose mode, and ii) with default threading enabled:

```julia-repl
# In the root directory of `MyPackage.jl`
julia --proj

julia> using Pkg

# No need to start a fresh session to change threading
julia> Pkg.test("MyModule"; test_args=`--verbose MytestsetA`, julia_args=`--threads=auto`);
```

## Packages using ParallelTestRunner.jl

There are a few packages already using `ParallelTestRunner.jl` to parallelize their tests, you can look at their setups if you need inspiration to move your packages as well:
Expand Down