docs: update hotpath usage instructions #5
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: Hotpath Comment | ||
| on: | ||
| workflow_run: | ||
| workflows: ["Hotpath Profile"] | ||
| types: | ||
| - completed | ||
| permissions: | ||
| pull-requests: write | ||
| jobs: | ||
| comment: | ||
| runs-on: ubuntu-latest | ||
| if: ${{ github.event.workflow_run.conclusion == 'success' }} | ||
| steps: | ||
| - name: Download profiling results | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: hotpath-results | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| run-id: ${{ github.event.workflow_run.id }} | ||
| - name: Read PR number | ||
| id: pr | ||
| run: echo "number=$(cat pr_number.txt)" >> $GITHUB_OUTPUT | ||
| - name: Setup Rust | ||
| uses: actions-rust-lang/setup-rust-toolchain@v1 | ||
| - name: Install hotpath CLI | ||
| run: cargo install hotpath | ||
| - name: Post timing comparison comment | ||
| run: | | ||
| hotpath profile-pr \ | ||
| --head-metrics head-timing.json \ | ||
| --base-metrics base-timing.json \ | ||
| --github-token ${{ secrets.GITHUB_TOKEN }} \ | ||
| --pr-number ${{ steps.pr.outputs.number }} | ||
| - name: Post allocation comparison comment | ||
| run: | | ||
| hotpath profile-pr \ | ||
| --head-metrics head-alloc.json \ | ||
| --base-metrics base-alloc.json \ | ||
| --github-token ${{ secrets.GITHUB_TOKEN }} \ | ||
| --pr-number ${{ steps.pr.outputs.number }} | ||
