A
adding-benchmarks
Add new benchmarks to the CI pipeline. Guides through creating benchmark JSON files, integrating with bootstrap.sh, and ensuring proper CI upload via ci3.yml workflow.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Add new benchmarks to the CI pipeline. Guides through creating benchmark JSON files, integrating with bootstrap.sh, and ensuring proper CI upload via ci3.yml workflow.
How to use
- Utwórz plik benchmark w formacie JSON w katalogu
bench-out/swojego pakietu, nadając mu nazwę*.bench.json. Każdy wpis powinien zawierać polename(identyfikator metryki),value(zmierzona wartość) iunit(jednostka miary, np. ms, bytes). - Strukturyzuj nazwy benchmarków za pomocą ukośników
/aby utworzyć logiczną hierarchię — ostatni segment nazwy stanie się nazwą wykresu na dashboardzie, a wszystkie poprzednie segmenty utworzą strukturę folderów. - Upewnij się, że Twój pakiet jest uwzględniony w procesie agregacji poprzez
bench_mergew głównym plikubootstrap.sh— narzędzie automatycznie połączy wszystkie pliki JSON i doda prefiks ścieżki pakietu. - Skonfiguruj workflow CI w pliku
ci3.ymlaby przesyłał scalony plik JSON do cache'a CI i uruchamiał GitHub Action odpowiedzialny za upload do panelu benchmarków. - Zweryfikuj wyniki na żywym dashboardzie dostępnym pod adresem https://aztecprotocol.github.io/benchmark-page-data/bench/?branch=next — powinieneś zobaczyć swoje benchmarki w odpowiedniej grupie hierarchicznej.