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

v3: Refactor Benchmark Results Workflow #3082

Merged
merged 3 commits into from
Jul 22, 2024
Merged

v3: Refactor Benchmark Results Workflow #3082

merged 3 commits into from
Jul 22, 2024

Conversation

gaby
Copy link
Member

@gaby gaby commented Jul 21, 2024

Description

  • Updated Benchmarks workflow based on practices seen in other projects.
  • The cache is now store/restored using the latest SHA and the cpu-model.
  • During a PR the Benchmarks are compared with the latest results from main
  • During a merge, the Benchmark results are updated and saved to cache
    • GitHub Pages will also be updated, although it's disabled right now until v3 is official.

Changes introduced

  • Benchmarks: Describe any performance benchmarks and improvements related to the changes.

@gaby gaby requested a review from a team as a code owner July 21, 2024 23:05
@gaby gaby requested review from sixcolors, ReneWerner87 and efectn and removed request for a team July 21, 2024 23:05
Copy link
Contributor

coderabbitai bot commented Jul 21, 2024

Warning

Rate limit exceeded

@gaby has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 12 minutes and 48 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 386c70d and b893be1.

Walkthrough

The changes enhance the GitHub Actions benchmark workflow by adding permissions for deployments and content management, enabling the publication of benchmark results to GitHub Pages. It improves data tracking by incorporating the SHA of the main branch and modifying cache keys based on the environment. The workflow also clarifies previous steps by renaming them and restricting certain actions to the main branch, ultimately streamlining benchmark management and visibility.

Changes

Files Change Summary
.github/workflows/benchmark.yml Added permissions for deployments and contents; modified caching key to include SHA, OS, and CPU model; renamed saving step; added a new step for publishing results to GitHub Pages; conditioned steps for main branch only.

Poem

In the world of code, a rabbit hops high,
With permissions granted, we now reach the sky!
Benchmarks are saved, results in a row,
GitHub Pages gleam, watch our progress grow.
Hooray for the changes, let’s celebrate cheer,
With each little hop, our goals draw near! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9ea7651 and 386c70d.

Files selected for processing (1)
  • .github/workflows/benchmark.yml (2 hunks)
Additional comments not posted (5)
.github/workflows/benchmark.yml (5)

12-16: Permissions section looks good.

The added permissions for deployments and contents are necessary for publishing benchmark results to GitHub Pages and updating benchmark contents.


35-39: System information retrieval step looks good.

Retrieving system information ensures that benchmark results are comparable across different environments.


40-52: SHA retrieval and caching steps look good.

Retrieving the main branch SHA and caching benchmark results based on SHA, OS, and CPU model ensures accurate tracking and comparison of benchmarks.


68-99: Storing and publishing benchmark results steps look good.

Storing benchmark results for the main branch and publishing them to GitHub Pages improve the visibility and management of benchmark outcomes.


100-105: Updating benchmark results cache step looks good.

Updating the benchmark results cache for the main branch ensures that the latest results are cached for future comparisons.

Copy link

codecov bot commented Jul 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.14%. Comparing base (9ea7651) to head (b893be1).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3082   +/-   ##
=======================================
  Coverage   83.14%   83.14%           
=======================================
  Files         115      115           
  Lines        8332     8332           
=======================================
  Hits         6928     6928           
  Misses       1075     1075           
  Partials      329      329           
Flag Coverage Δ
unittests 83.14% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ReneWerner87 ReneWerner87 merged commit 9c0cb9d into main Jul 22, 2024
16 checks passed
@gaby gaby deleted the benchmark-ci branch July 22, 2024 10:16
gaby added a commit that referenced this pull request Jul 25, 2024
* Refactor benchmarks workflow

* Use full semver tag

* Add fetch depth
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants