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

Better CI file Docs #273

Open
MahdiBM opened this issue Sep 15, 2024 · 1 comment
Open

Better CI file Docs #273

MahdiBM opened this issue Sep 15, 2024 · 1 comment

Comments

@MahdiBM
Copy link
Contributor

MahdiBM commented Sep 15, 2024

As I mentioned to @hassila while he was helping me understand this great benchmarking package, I've put together some CI files that I think can be very nice to have for others as well.

I propose updating the docs CI section to point to a bunch of different sample CI files, each with a short explanation, so users have options on choosing how to put together their CI.

To meet our needs at work, I've created these 2 CI files that I propose to somehow add to the docs since they can be helpful for others as well:

  1. Benchmarking against thresholds. Advantages compared to the default CI that currently is in the docs:
  • Checks against static thresholds, not the default branch.
  • Caches the .build for faster benchmarking.
  • Sends a comment with full info to the related PR, if existent.
  • The benchmark results are attached to the comment too, other than the check result.
  • The formatting looks much nicer:
    • The blue timestamp text, links to a website to see the time in your own timezone if needed.

Screenshot 2024-09-13 at 7 28 58 PM

  1. Updating Thresholds Using The Same CI Running The Benchmarks
  • You can manually trigger this workflow for your branches.
  • It then commits the changes to the branch.
@hassila
Copy link
Contributor

hassila commented Oct 4, 2024

Hi @MahdiBM, sorry for the long turn around, but the raft of cases you created lead to a new improved implementation in n #284 for static thresholds management. Would be great if you would have a look and see if it clears up most of your issues - it leads to this issue to be updated to the new commands for static threshold management then - if you're up for it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants