add a template and plugin for PkgBenchmarks (#261)

* add a template and plugin for BenchmarkTools * Rename into PkgBenchmark * Fix tests * Docstring --------- Co-authored-by: = <=> Co-authored-by: Guillaume Dalle <[email protected]>
JuliaCI · Dec 18, 2023 · dea191b · dea191b
1 parent e7b5a51
commit dea191b
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 0 deletions.
diff --git a/docs/src/user.md b/docs/src/user.md
@@ -96,6 +96,7 @@ Citation
 RegisterAction
 Formatter
 CodeOwners
+PkgBenchmark
 ```
 
 ## A More Complicated Example

diff --git a/src/PkgTemplates.jl b/src/PkgTemplates.jl
@@ -37,6 +37,7 @@ export
     License,
     Logo,
     NoDeploy,
+    PkgBenchmark,
     PkgEvalBadge,
     ProjectFile,
     Readme,

diff --git a/src/plugin.jl b/src/plugin.jl
@@ -376,3 +376,4 @@ include(joinpath("plugins", "badges.jl"))
 include(joinpath("plugins", "register.jl"))
 include(joinpath("plugins", "dependabot.jl"))
 include(joinpath("plugins", "formatter.jl"))
+include(joinpath("plugins", "pkgbenchmark.jl"))
diff --git a/src/plugins/pkgbenchmark.jl b/src/plugins/pkgbenchmark.jl
@@ -0,0 +1,21 @@
+"""
+    PkgBenchmark(; file="$(contractuser(default_file("benchmark", "benchmarks.jl")))")
+
+Sets up a [PkgBenchmark.jl](https://github.com/JuliaCI/PkgBenchmark.jl) benchmark suite.
+
+To ensure benchmark reproducibility, you will need to manually create an environment in the `benchmark` subfolder (for which the `Manifest.toml` is committed to version control).
+In this environment, you should at the very least:
+
+- `pkg> add BenchmarkTools`
+- `pkg> dev` your new package.
+
+## Keyword Arguments
+- `file::AbstractString`: Template file for `benchmarks.jl`.
+"""
+@plugin struct PkgBenchmark <: FilePlugin
+    file::String = default_file("benchmark", "benchmarks.jl")
+end
+
+source(p::PkgBenchmark) = p.file
+destination(::PkgBenchmark) = joinpath("benchmark", "benchmarks.jl")
+view(::PkgBenchmark, ::Template, pkg::AbstractString) = Dict("PKG" => pkg)
diff --git a/templates/benchmark/benchmarks.jl b/templates/benchmark/benchmarks.jl
@@ -0,0 +1,7 @@
+using {{{PKG}}}
+using BenchmarkTools
+
+SUITE = BenchmarkGroup()
+SUITE["rand"] = @benchmarkable rand(10)
+
+# Write your benchmarks here.
diff --git a/test/fixtures/WackyOptions/benchmark/benchmarks.jl b/test/fixtures/WackyOptions/benchmark/benchmarks.jl
@@ -0,0 +1,7 @@
+using WackyOptions
+using BenchmarkTools
+
+SUITE = BenchmarkGroup()
+SUITE["rand"] = @benchmarkable rand(10)
+
+# Write your benchmarks here.
diff --git a/test/reference.jl b/test/reference.jl
@@ -157,6 +157,7 @@ end
             GitHubActions(; x86=true, linux=false, coverage=false),
             GitLabCI(; coverage=false, extra_versions=[v"0.6"]),
             License(; name="ISC"),
+            PkgBenchmark(),
             PkgEvalBadge(),
             ProjectFile(; version=v"1"),
             Readme(; inline_badges=true, badge_off=[Codecov]),