Skip to content

Commit b6362d6

Browse files
committed
Step 3: Explain how to build the results site locally
1 parent 14156e6 commit b6362d6

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,16 @@ it ran on:
112112
RESULTS_DIR=results RESULTS_LABEL=ruby_3.4 docker compose run --rm ruby_3.4 code/your-new/entry.rb
113113
```
114114

115+
To see those results the way the results site shows them, build the site
116+
into `_site/`, then open `_site/index.html` in a browser:
117+
118+
```
119+
docker compose run --rm -T --entrypoint ruby ruby_4.0 script/build_results_site.rb results _site
120+
```
121+
122+
CI does the same after every run: the site is attached to the run as the
123+
`site-preview` artifact, and published to GitHub Pages from `main`.
124+
115125
## Benchmarks that need a newer Ruby
116126

117127
CI runs every benchmark on every Ruby in `compose.yaml`, back to Ruby 2.1, and

0 commit comments

Comments
 (0)