tkf / BenchmarkCI.jl
Showing 1 of 1 files from the diff.
Newly tracked file
src/BenchmarkCI.jl changed.

@@ -94,6 +94,24 @@
Loading
94 94
    return string(minutes, " minutes ", floor(Int, seconds - 60 * minutes), " seconds")
95 95
end
96 96
97 +
"""
98 +
    judge()
99 +
100 +
Run `benchmarkpkg` on `target` and `baseline`.
101 +
102 +
# Keyword Arguments
103 +
- `target :: Union{Nothing, AbstractString, BenchmarkConfig} = nothing`:
104 +
  Benchmark target configuration.  Default to the checked out working tree.  A
105 +
  git commitish can be passed as a string.  `PkgBenchmark.BenchmarkConfig`
106 +
  can be used for more detailed control (see PkgBenchmark.jl manual).
107 +
- `baseline :: Union{AbstractString, BenchmarkConfig} = "origin/master"`:
108 +
  Benchmark baseline configuration.  See `target.`
109 +
- `pkgdir :: AbstractString = pwd()`: Package root directory.
110 +
- `script :: AbstractString = "\$pkgdir/benchmark/benchmarks.jl"`: The script
111 +
  that defines the `SUITE` global variable/constant.
112 +
- `project :: AbstractString = dirname(script)`: The project used to define
113 +
  and run benchmarks.
114 +
"""
97 115
judge(; target = nothing, baseline = "origin/master", kwargs...) =
98 116
    judge(target, baseline; kwargs...)
99 117
@@ -191,7 +209,7 @@
Loading
191 209
    CIResult(judgement = _loadjudge(workspace))
192 210
193 211
"""
194 -
    postjudge()
212 +
    postjudge(; title = "Benchmark result")
195 213
196 214
Post judgement as comment.
197 215
"""
@@ -299,6 +317,11 @@
Loading
299 317
    @info "Comment posted."
300 318
end
301 319
320 +
"""
321 +
    displayjudgement()
322 +
323 +
Print result of `BenchmarkCI.judge`.
324 +
"""
302 325
displayjudgement(workspace::AbstractString = DEFAULT_WORKSPACE) =
303 326
    displayjudgement(_loadjudge(workspace))
304 327
Files Coverage
src 83.55%
Project Totals (2 files) 83.55%
Untitled

No yaml found.

Create your codecov.yml to customize your Codecov experience

Sunburst
The inner-most circle is the entire project, moving away from the center are folders then, finally, a single file. The size and color of each slice is representing the number of statements and the coverage, respectively.
Icicle
The top section represents the entire project. Proceeding with folders and finally individual files. The size and color of each slice is representing the number of statements and the coverage, respectively.
Grid
Each block represents a single file in the project. The size and color of each block is represented by the number of statements and the coverage, respectively.
Loading