Use Kotlin DSL for benchmark workflow #40
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Run Benchmarks | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| env: | |
| BENCHMARK_RESULTS: snake-kmp-benchmarks/build/reports/benchmarks | |
| concurrency: | |
| group: ${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| run-benchmark: | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| include: | |
| - os: ubuntu-latest | |
| - os: macos-latest | |
| additional-args: '-x jvmBenchmark -x jsBenchmark' | |
| - os: macos-13 # for macosX64 | |
| additional-args: '-x jvmBenchmark -x jsBenchmark' | |
| - os: windows-latest | |
| additional-args: '-x jvmBenchmark -x jsBenchmark' | |
| name: Performance regression check on ${{ matrix.os }} runner | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: 'Set up JDK' | |
| uses: 'actions/setup-java@v4' | |
| with: | |
| java-version: '11' | |
| distribution: 'zulu' | |
| cache: 'gradle' | |
| - name: Validate Gradle Wrapper | |
| uses: gradle/actions/wrapper-validation@v3 | |
| - name: Setup Gradle | |
| uses: gradle/actions/setup-gradle@v3 | |
| with: | |
| gradle-version: wrapper | |
| - name: Run benchmarks | |
| run: ./gradlew -p snake-kmp-benchmarks benchmark --no-parallel ${{ matrix.additional-args }} | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: bench-results-${{ matrix.os }} | |
| path: ${{ env.BENCHMARK_RESULTS }}/main/**/*.json | |
| collect-benchmarks-results: | |
| runs-on: ubuntu-latest | |
| needs: | |
| - run-benchmark | |
| env: | |
| RESULTS_DIR: bench-results | |
| steps: | |
| # without checkout step 'benchmark-action/github-action-benchmark' action won't work | |
| - uses: actions/checkout@v4 | |
| - name: Download benchmark results | |
| uses: actions/download-artifact@v4 | |
| with: | |
| pattern: bench-results-* | |
| path: ${{ env.RESULTS_DIR }} | |
| merge-multiple: true | |
| - name: Prepare and join benchmark reports | |
| id: prep | |
| run: | | |
| for report in $(find ./${{ env.RESULTS_DIR }} -type f -name "*.json") | |
| do | |
| echo "$report:" | |
| cat "$report" | |
| file_name=$(basename "$report") | |
| platform="${file_name%.*}" | |
| # Trim 'it.krzeminski.snakeyaml.engine.kmp.benchmark.' to make benchmark name more readable | |
| jq "[ .[] | .benchmark |= \"${platform}.\" + ltrimstr(\"it.krzeminski.snakeyaml.engine.kmp.benchmark.\") | .params |= map_values(. |= match(\"data.+\"; \"g\").string) ]" $report > ${{ env.RESULTS_DIR }}/$platform.json | |
| done | |
| AGGREGATED_REPORT=aggregated.json | |
| # Joined reports looks like this: [[{},{}], [{},{}]] | |
| # We need to transform them into this: [{},{}] | |
| ls ${{ env.RESULTS_DIR }}/*.json | |
| jq -s '[ .[] | .[] ]' ${{ env.RESULTS_DIR }}/*.json > $AGGREGATED_REPORT | |
| echo "Aggregated report" | |
| cat "$AGGREGATED_REPORT" | |
| echo "report=$AGGREGATED_REPORT" >> $GITHUB_OUTPUT | |
| - name: Store benchmark result | |
| uses: benchmark-action/github-action-benchmark@v1 | |
| with: | |
| name: SnakeKMP benchmarks | |
| tool: 'jmh' | |
| output-file-path: ${{ steps.prep.outputs.report }} | |
| comment-on-alert: true | |
| summary-always: true | |
| alert-threshold: '150%' | |
| fail-threshold: '200%' | |
| gh-repository: github.com/krzema12/snakeyaml-engine-kmp-benchmarks | |
| github-token: ${{ secrets.PUBLISH_BENCHMARK_RESULTS }} | |
| # Push and deploy GitHub pages branch automatically only if run in main repo and not in PR | |
| auto-push: ${{ github.repository == 'krzema12/snakeyaml-engine-kmp' && github.event_name != 'pull_request' }} |