Add GitHub Actions workflow for benchmark reporting and release packaging

- Introduced a new step in the CI workflow to run benchmarks and package the results for release.
- Added functionality to publish benchmark reports to GitHub Pages, enhancing visibility of performance metrics.
- Updated the README in the benches directory to include a release summary table for tracking benchmark results across versions.

Author: TKorr

.github/workflows/release.yml

@@ -19,15 +19,35 @@ jobs:
     name: GitHub Release
     runs-on: ubuntu-latest
     steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+      - name: Run benchmarks
+        run: cargo bench --no-fail-fast
+      - name: Package benchmark results
+        run: tar -czf criterion-results.tar.gz target/criterion
+      - name: Prepare gh-pages publish directory
+        run: |
+          mkdir -p target/gh-pages/benchmarks/${{ github.ref_name }}
+          mkdir -p target/gh-pages/benchmarks/latest
+          cp -R target/criterion/. target/gh-pages/benchmarks/${{ github.ref_name }}/
+          cp -R target/criterion/. target/gh-pages/benchmarks/latest/
+      - name: Publish benchmark report to gh-pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: target/gh-pages
       - name: Create release for tag push
         if: github.event_name == 'push'
         uses: softprops/action-gh-release@v2
         with:
           generate_release_notes: true
+          files: criterion-results.tar.gz
 
       - name: Create release for manual dispatch
         if: github.event_name == 'workflow_dispatch'
         uses: softprops/action-gh-release@v2
         with:
           tag_name: ${{ inputs.tag }}
           generate_release_notes: true
+          files: criterion-results.tar.gz

benches/README.md

@@ -35,3 +35,12 @@ Notes:
 - Values above are from `cargo bench --bench lru`, `--bench lru_k`, and
   `--bench lfu` run in the same session.
 - Throughput is derived from `Throughput::Elements(...)` in the benchmarks.
+
+## Release summary (tagged)
+
+Use this table to track benchmarks captured for releases. Update after tagging
+and running the release benchmarks.
+
+| Release | Date | Environment | Micro-ops (ns/op) | Policy throughput (Melem/s) | Workload throughput (Melem/s) | Report link |
+| --- | --- | --- | --- | --- | --- | --- |
+| v0.1.0 | 2025-01-12 | TBD | TBD | TBD | TBD | TBD |