Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Commit benchmark results to gh-pages branch #250

Merged
merged 2 commits into from
Dec 14, 2020

Conversation

NathanielRN
Copy link
Contributor

@NathanielRN NathanielRN commented Dec 11, 2020

Description

A follow up to the Core PR that adds benchmarking tests: open-telemetry/opentelemetry-python#1443

We added an issue in #249 and link the issue in the code here

We also found out that the GitHub action will fetch the branch even if it on that branch which produces an error.

This PR goes back to using gh-pages and adds a link in the ReadTheDocs directory to point to the benchmarks graphs which will live on the gh-pages branch.

This is also a good idea to reduce the noise on the master branch.

This will fix the current Contrib Repo Tests.

Type of change

  • Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

See my example repo which uses gh-pages correctly to publish to https://nathanielrn.github.io/github-benchmarks-example/benchmarks/index.html

Does This PR Require a Contrib Repo Change?

  • No.

Checklist:

  • Followed the style guidelines of this project
  • Documentation has been updated

@NathanielRN NathanielRN requested review from a team, owais and aabmass and removed request for a team December 11, 2020 19:31
@NathanielRN NathanielRN changed the title Link issue to add more benchmarking tests Only commit benchmark results to master folder Dec 11, 2020
@NathanielRN NathanielRN force-pushed the link-benchmarks-issue branch 3 times, most recently from 5973235 to ef4af96 Compare December 11, 2020 21:18
@NathanielRN
Copy link
Contributor Author

Tests failing for now because we don't have a gh-pages branch

@@ -51,7 +51,7 @@ for more detail on available tox commands.

### Benchmarks

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as other PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@NathanielRN NathanielRN changed the title Only commit benchmark results to master folder Commit benchmark results to gh-pages branch Dec 11, 2020
@codeboten codeboten added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Dec 11, 2020
@NathanielRN NathanielRN force-pushed the link-benchmarks-issue branch 2 times, most recently from a1cf732 to 106fd76 Compare December 12, 2020 07:42
Performance Tests - Benchmarks
==============================

Click `here <https://open-telemetry.github.io/opentelemetry-python-contrib/benchmarks/index.html>_` to view the latest performance benchmarks for packages in this repo.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to wait for #252 to add this to the toc tree, otherwise we can just add the toc tree entry after #252 gets merged.

@codeboten codeboten merged commit 4b83077 into open-telemetry:master Dec 14, 2020
@NathanielRN NathanielRN deleted the link-benchmarks-issue branch December 14, 2020 22:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants