You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -21,21 +21,21 @@ Backticks are mandatory. There are two kinds of jobs you can invoke: **benchmark
21
21
One of the most common invocations runs all benchmarks on your PR, comparing against the current Julia master branch:
22
22
23
23
```
24
-
@nanosoldier `runbenchmarks(ALL, vs=":master")`
24
+
@nanosoldier `runbenchmarks(ALL)`
25
25
```
26
26
27
27
Similarly, you can run all package tests, e.g. if you suspect your PR might be breaking:
28
28
29
29
```
30
-
@nanosoldier `runtests(ALL, vs = ":master")`
30
+
@nanosoldier `runtests(ALL)`
31
31
```
32
32
33
33
Both operations take a long time, so it might be wise to restrict which benchmarks you want to run, or which packages you want to test:
34
34
35
35
```
36
-
@nanosoldier `runbenchmarks("linalg", vs = ":master")`
36
+
@nanosoldier `runbenchmarks("linalg"")`
37
37
38
-
@nanosoldier `runtests(["JSON", "Crayons"], vs = ":master")`
38
+
@nanosoldier `runtests(["JSON", "Crayons"])`
39
39
```
40
40
41
41
When a job is completed, @nanosoldier will reply to your comment to tell you how the job went and link you to any relevant results.
@@ -64,7 +64,7 @@ A `BenchmarkJob` is triggered with the following syntax:
64
64
@nanosoldier `runbenchmarks(tag_predicate, vs = "ref")`
65
65
```
66
66
67
-
The `vs` keyword argument is optional, and is used to determine whether or not the comparison step (step 3 above) is performed.
67
+
The `vs` keyword argument is optional; if invoked from a pull request, it will be derived automatically from the merge base. In other cases, the comparison step (step 3 above) will be skipped.
68
68
69
69
The tag predicate is used to decide which benchmarks to run, and supports the syntax defined by the [tagging system](https://github.com/JuliaCI/BenchmarkTools.jl/blob/master/doc/manual.md#indexing-into-a-benchmarkgroup-using-tagged) implemented in the [BenchmarkTools](https://github.com/JuliaCI/BenchmarkTools.jl) package. Additionally, you can run all benchmarks by using the keyword `ALL`, e.g. `runbenchmarks(ALL)`.
70
70
@@ -154,7 +154,7 @@ A `PkgEvalJob` is triggered with the following syntax:
154
154
155
155
The package selection argument is used to decide which packages to test. It should be a list of package names, e.g. `["Example"]`, that will be looked up in the registry. Additionally, you can test all packages in the registry by using the keyword `ALL`, e.g. `runtests(ALL)`.
156
156
157
-
The `vs` keyword argument is optional, and is used to determine whether or not the comparison step (step 3 above) is performed. Its syntax is identical to the `BenchmarkJob``vs` keyword argument.
157
+
The `vs` keyword argument is again optional. Its syntax and behavior is identical to the `BenchmarkJob``vs` keyword argument.
158
158
159
159
Both sides of the comparison can be further configured by using respectively the `configuration` and `vs_configuration` arguments. These options expect a named tuple where the elements correspond to fields of the `PkgEval.Configuration` type.
0 commit comments