ixa 1.0.0

A framework for building agent-based models
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

name: Benchmark Pull Requests

on:
  pull_request:

jobs:
  compare-branches:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: write
    steps:
      - uses: actions/checkout@v6
      - name: Setup environment
        uses: ./.github/actions/setup-env

      - name: Checkout base branch
        uses: actions/checkout@v6
        with:
          ref: ${{ github.event.pull_request.base.ref }}
          # This fetches all branches so we can compare the PR branch with the base branch
          fetch-depth: 0

      - name: Create a benchmark baseline
        run: mise run bench:create '' base || echo "Could not create baseline"

      - name: Checkout PR branch
        # The checkout is done manually to avoid cleaning up the baseline benchmark
        run: git checkout ${{ github.event.pull_request.head.ref }}

      - name: Run hyperfine benchmarks
        run: mise run bench:hyperfine -- -- --export-markdown hyperfine.md

      - name: Run benchmarks on head branch and format output
        run: |
          echo '### Benchmark Results' > results.md
          echo '' >> results.md
          echo '#### Hyperfine' >> results.md
          echo '' >> results.md
          echo '```' >> results.md
          cat hyperfine.md >> results.md
          echo '```' >> results.md
          echo '' >> results.md
          echo '#### Criterion' >> results.md
          echo '' >> results.md
          if ! cargo bench -p ixa-bench -- --baseline base 2>&1; then
            echo "Note: A comparison could not be generated. Maybe you added new benchmarks?" >> results.md
            mise run bench:criterion 2>&1
          else
            echo '```' >> results.md
            cargo run -q -p ixa-bench --bin check_criterion_regressions >> results.md
            echo '```' >> results.md
          fi

      - name: Add comment to PR
        run: |
          gh pr comment ${{ github.event.pull_request.number }} \
            --repo ${{ github.repository }} \
            --body-file results.md
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}