ShadowMap/.github/workflows/codeprofiling.yml at 484e33536257de1815b6209dde55580b8d6007c2 · mdabir1203/ShadowMap · GitHub

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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
name: hotpath-profile

on:
  pull_request:

permissions:
  contents: read

jobs:
  profile:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2
        id: rust_cache
        with:
          shared-key: profiling

      - name: Note cache status
        env:
          CACHE_HIT: ${{ steps.rust_cache.outputs.cache-hit }}
        run: |
          echo "### Build cache" >> "$GITHUB_STEP_SUMMARY"
          echo >> "$GITHUB_STEP_SUMMARY"
          if [ "$CACHE_HIT" = "true" ]; then
            echo "Using cached cargo artifacts for hotpath profiling run." >> "$GITHUB_STEP_SUMMARY"
          else
            echo "Cache miss for hotpath profiling job. This is normal on the first run for a branch or after toolchain changes; the next run will populate the cache." >> "$GITHUB_STEP_SUMMARY"
          fi

      - id: head_timing_metrics
        run: |
          # Extract timing metrics from head branch
          {
            echo 'metrics<<EOF'
            cargo run --example benchmark --features='hotpath,hotpath-ci' | grep '^{"hotpath_profiling_mode"'
            echo 'EOF'
          } >> "$GITHUB_OUTPUT"

      - id: head_alloc_metrics
        run: |
          # Extract alloc metrics from head branch
          {
            echo 'metrics<<EOF'
            cargo run --example benchmark --features='hotpath,hotpath-ci,hotpath-alloc-count-total' | grep '^{"hotpath_profiling_mode"'
            echo 'EOF'
          } >> "$GITHUB_OUTPUT"

      - name: Checkout base
        run: |
          git checkout ${{ github.event.pull_request.base.sha }}

      - id: base_timing_metrics
        run: |
          # Extract timing metrics from base branch
          {
            echo 'metrics<<EOF'
            cargo run --example benchmark --features='hotpath,hotpath-ci' | grep '^{"hotpath_profiling_mode"'
            echo 'EOF'
          } >> "$GITHUB_OUTPUT"

      - id: base_alloc_metrics
        run: |
          # Extract alloc metrics from base branch
          {
            echo 'metrics<<EOF'
            cargo run --example benchmark --features='hotpath,hotpath-ci,hotpath-alloc-count-total' | grep '^{"hotpath_profiling_mode"'
            echo 'EOF'
          } >> "$GITHUB_OUTPUT"

      - name: Save metrics to artifact
        run: |
          mkdir -p /tmp/metrics
          echo '${{ steps.head_timing_metrics.outputs.metrics }}' > /tmp/metrics/head_timing.json
          echo '${{ steps.base_timing_metrics.outputs.metrics }}' > /tmp/metrics/base_timing.json
          echo '${{ steps.head_alloc_metrics.outputs.metrics }}' > /tmp/metrics/head_alloc.json
          echo '${{ steps.base_alloc_metrics.outputs.metrics }}' > /tmp/metrics/base_alloc.json
          echo '${{ github.event.pull_request.number }}' > /tmp/metrics/pr_number.txt

      - name: Publish metrics summary
        env:
          HEAD_TIMING: ${{ steps.head_timing_metrics.outputs.metrics }}
          BASE_TIMING: ${{ steps.base_timing_metrics.outputs.metrics }}
          HEAD_ALLOC: ${{ steps.head_alloc_metrics.outputs.metrics }}
          BASE_ALLOC: ${{ steps.base_alloc_metrics.outputs.metrics }}
        run: |
          {
            echo "## Hotpath profiling metrics"
            echo
            echo "### Timing"
            echo
            echo "<details><summary>Head</summary>"
            echo
            printf '```json\n'
            if [ -n "$HEAD_TIMING" ]; then
              printf '%s\n' "$HEAD_TIMING"
            else
              echo '{}'
            fi
            printf '```\n'
            echo
            echo "</details>"
            echo
            echo "<details><summary>Base</summary>"
            echo
            printf '```json\n'
            if [ -n "$BASE_TIMING" ]; then
              printf '%s\n' "$BASE_TIMING"
            else
              echo '{}'
            fi
            printf '```\n'
            echo
            echo "</details>"
            echo
            echo "### Allocation"
            echo
            echo "<details><summary>Head</summary>"
            echo
            printf '```json\n'
            if [ -n "$HEAD_ALLOC" ]; then
              printf '%s\n' "$HEAD_ALLOC"
            else
              echo '{}'
            fi
            printf '```\n'
            echo
            echo "</details>"
            echo
            echo "<details><summary>Base</summary>"
            echo
            printf '```json\n'
            if [ -n "$BASE_ALLOC" ]; then
              printf '%s\n' "$BASE_ALLOC"
            else
              echo '{}'
            fi
            printf '```\n'
            echo
            echo "</details>"
          } >> "$GITHUB_STEP_SUMMARY"

      - uses: actions/upload-artifact@v4
        with:
          name: profile-metrics
          path: /tmp/metrics/
          retention-days: 1