Skip to content

Commit 2f1f13f

Browse files
authored
Use gh-pages to save performance benchmarks results (#1469)
1 parent 496ed8b commit 2f1f13f

File tree

4 files changed

+14
-2
lines changed

4 files changed

+14
-2
lines changed

Diff for: .github/workflows/test.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ jobs:
8484
fail-on-alert: true
8585
# Make a commit on `gh-pages` with benchmarks from previous step
8686
auto-push: ${{ github.ref == 'refs/heads/master' }}
87-
gh-pages-branch: master
87+
gh-pages-branch: gh-pages
8888
benchmark-data-dir-path: benchmarks
8989
misc:
9090
strategy:

Diff for: CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ for more detail on available tox commands.
6868

6969
### Benchmarks
7070

71-
Performance progression of benchmarks for packages distributed by OpenTelemetry Python can be viewed as a [graph of throughput vs commit history](https://opentelemetry-python.readthedocs.io/en/latest/benchmarks/index.html). From this page, you can download a JSON file with the performance results.
71+
Performance progression of benchmarks for packages distributed by OpenTelemetry Python can be viewed as a [graph of throughput vs commit history](https://opentelemetry-python.readthedocs.io/en/latest/performance/benchmarks.html). From the linked page, you can download a JSON file with the performance results.
7272

7373
Running the `tox` tests also runs the performance tests if any are available. Benchmarking tests are done with `pytest-benchmark` and they output a table with results to the console.
7474

Diff for: docs/index.rst

+8
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,14 @@ install <https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs>
9191

9292
instrumentation/**
9393

94+
.. toctree::
95+
:maxdepth: 1
96+
:caption: OpenTelemetry Python Performance
97+
:name: performance-tests
98+
:glob:
99+
100+
performance/**
101+
94102
.. toctree::
95103
:maxdepth: 1
96104
:caption: Examples

Diff for: docs/performance/benchmarks.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Performance Tests - Benchmarks
2+
==============================
3+
4+
Click `here <https://open-telemetry.github.io/opentelemetry-python/benchmarks/index.html>`_ to view the latest performance benchmarks for packages in this repo.

0 commit comments

Comments
 (0)