Run Benchmark #96
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 Benchmark' | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| bench-file: | |
| required: true | |
| type: string | |
| node-versions: | |
| required: true | |
| type: string | |
| default: '["18.0.0", "18.18.0", "18.19.0", "20.0.0", "20.10.0", "20.11.1", "21.0.0", "21.6.0", "21.7.1"]' | |
| description: 'The Node.js Versions (should be a JSON array)' | |
| node-opts: | |
| required: false | |
| type: string | |
| description: 'Flags to be used in the Node.js binary' | |
| workflow_call: | |
| inputs: | |
| bench-file: | |
| required: true | |
| type: string | |
| node-versions: | |
| required: true | |
| type: string | |
| description: 'The Node.js Versions (should be a JSON array)' | |
| node-opts: | |
| required: false | |
| type: string | |
| description: 'Flags to be used in the Node.js binary' | |
| permissions: | |
| issues: write | |
| jobs: | |
| benchmark: | |
| continue-on-error: true | |
| runs-on: ubuntu-latest | |
| # runs-on: self-hosted | |
| strategy: | |
| matrix: | |
| node-version: ${{ fromJson(inputs.node-versions) }} | |
| fail-fast: true | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Use Node.js v${{ matrix.node-version }} | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| - name: NPM Install | |
| run: npm install | |
| - name: Report Filename | |
| run: echo "BENCH_REPORT_FILE=report-${{github.run_id}}-${{ matrix.node-version }}-${{ inputs.bench-file }}.md" >> $GITHUB_ENV | |
| - name: Run Benchmark | |
| run: node ${{ inputs.node-opts }} bench/${{ inputs.bench-file }} > ./${{ env.BENCH_REPORT_FILE }} | |
| env: | |
| CI: true | |
| - name: Notify on Error | |
| if: ${{ failure() }} | |
| uses: dacbd/create-issue-action@main | |
| with: | |
| token: ${{ github.token }} | |
| title: Benchmark ${{ inputs.bench-file }} failed on v${{ matrix.node-version }} | |
| body: | | |
| ### Context | |
| [Failed Run](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}) | |
| [Codebase](https://github.com/${{ github.repository }}/tree/${{ github.sha }}) | |
| Workflow name - `${{ github.workflow }}` | |
| Job - `${{ github.job }}` | |
| status - `${{ job.status }}` | |
| assignees: RafaelGSS | |
| labels: bug | |
| - name: Output Failure | |
| if: ${{ failure() }} | |
| uses: cloudposse/github-action-matrix-outputs-write@main | |
| with: | |
| matrix-step-name: benchmark-${{ inputs.bench-file }} | |
| matrix-key: ${{ matrix.node-version }} | |
| outputs: |- | |
| failure: 'true' | |
| result: '' | |
| - name: Add Job Summary | |
| run: | | |
| result=$(cat ./${{ env.BENCH_REPORT_FILE }}) | |
| echo "$result" >> $GITHUB_STEP_SUMMARY | |
| - name: Upload Bench Result | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: benchmark-artifacts-${{github.run_id}} | |
| retention-days: 1 | |
| if-no-files-found: error | |
| path: ./${{ env.BENCH_REPORT_FILE }} | |
| ## Write for matrix outputs workaround | |
| - uses: cloudposse/github-action-matrix-outputs-write@main | |
| id: out | |
| with: | |
| matrix-step-name: benchmark-${{ inputs.bench-file }} | |
| matrix-key: ${{ matrix.node-version }} | |
| outputs: |- | |
| failure: 'false' | |
| result: ${{ env.BENCH_REPORT_FILE }} | |
| ## Read matrix outputs | |
| read: | |
| runs-on: ubuntu-latest | |
| continue-on-error: true | |
| needs: [benchmark] | |
| steps: | |
| - uses: cloudposse/github-action-matrix-outputs-read@main | |
| id: read | |
| with: | |
| matrix-step-name: benchmark-${{ inputs.bench-file }} | |
| outputs: | |
| result: '${{ steps.read.outputs.result }}' | |
| commit: | |
| runs-on: ubuntu-latest | |
| continue-on-error: true | |
| if: ${{ needs.read.outputs.failure != 'true' }} | |
| needs: [read] | |
| permissions: | |
| contents: write | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| ref: main | |
| - name: Use Node.js v20.x | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: 20.x | |
| - name: Create temporary report folder | |
| run: mkdir ./temp-reports | |
| - uses: actions/download-artifact@v3 | |
| with: | |
| name: benchmark-artifacts-${{github.run_id}} | |
| path: ./temp-reports | |
| - name: Write Benchmark Reports | |
| run: | | |
| node scripts/write-bench-results.mjs | |
| node scripts/generate-reports.mjs | |
| env: | |
| BENCH_FILE: ${{ inputs.bench-file }} | |
| BENCH_ARTIFACTS: ${{ needs.read.outputs.result }} | |
| - name: Clean temporary report folder | |
| run: rm -r ./temp-reports | |
| - name: Commit and Push Updated Results | |
| uses: stefanzweifel/git-auto-commit-action@v4 | |
| with: | |
| branch: 'main' | |
| commit_message: 'chore(${{ inputs.bench-file }}): update benchmark results' | |
| commit_author: Github Actions <[email protected]> |