Home

Jump to bottom

Dominique edited this page Mar 4, 2026 · 2 revisions

Setting up JSO Benchmarks in a Repository

Create a new folder named benchmark (NB: no final "s"). In that folder, create the following files:
- Project.toml: provide the dependencies for your benchmarks. At a minimum, this file should include
```
[deps]
BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
JSOBenchmarks = "9410e2bb-e8e7-4fa0-9768-685b196f59b5"
PkgBenchmark = "32113eaa-f34f-5b0d-bd6c-c81e245fc73d"
```
- benchmarks.jl (NB: with a final "s"). This file's only task is to define a BenchmarkTools suite.
Add the workflow jsobmarks.yml to your repository's .github/workflows/.
Create a gist token.
- In your personal GitHub settings, go to Developer settings > Personal access tokens > Tokens (classic).
- Click Generate new token, then select the gist scope to allow access to Gists.
- Copy the token: After generating the token, copy it immediately—you won’t be able to see it again.
- In the repository settings, go to Secrets and variables > Actions.
- Click on "New repository secret". Name your secret GIST_TOKEN and paste the token.
- Save the token in a secure place, such as a password manager.
Create a new label in your repository named "run benchmarks".