reorder benchmark and doc generation

Author: njericha

.github/workflows/ci.yml

@@ -7,13 +7,15 @@ on:
     - README.md
     - .gitignore
     - LICENSE.md
+    - 'docs/src/bench/**' # avoid feedback loop since benchmark modifies files in this path
   pull_request:
     branches:
       - main
     paths-ignore:
     - README.md
     - .gitignore
     - LICENSE.md
+    - 'docs/src/bench/**'
 env:
   JULIA_NUM_THREADS: 2
 jobs:
@@ -96,25 +98,8 @@ jobs:
           #file: lcov.info
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: false  # or true if you want CI to fail when Codecov fails
-  docs:
-    name: Documentation
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v2
-        with:
-          version: '1.12'
-      - run: |
-          julia --project=docs -e '
-            import Pkg;
-            Pkg.develop(Pkg.PackageSpec(path=pwd()))
-            Pkg.instantiate()'
-      - run: julia --project=docs docs/make.jl #Pkg.add("Documenter"); using Pkg
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
   benchmark:
-    needs: docs # ensures this is run after docs. docs replaces gh-pages branch so this needs to happen after
+    #needs: docs # ensures this is run after docs. docs replaces gh-pages branch so this needs to happen after
     name: Run Julia benchmark
     runs-on: ${{ matrix.os }}
     strategy:
@@ -138,12 +123,7 @@ jobs:
             import Pkg;
             Pkg.develop(Pkg.PackageSpec(path=pwd()));
             Pkg.instantiate()'
-      - name: Run benchmark # import Pkg; Pkg.add("BenchmarkTools") # Pkg.develop(PackageSpec(path=pwd()))
-          # julia --project=benchmark -e '
-            # using Pkg;
-            # Pkg.add("BenchmarkTools");
-            # Pkg.develop(PackageSpec(path=pwd()));
-            # Pkg.instantiate()'
+      - name: Run benchmark
         run: julia --project=benchmark benchmark/runbenchmarks.jl
       - uses: actions/cache@v4
         with:
@@ -173,20 +153,23 @@ jobs:
           alert-threshold: '200%'
           comment-on-alert: true
           fail-on-alert: false
-          #alert-comment-cc-users: '@ktrz,@findmyway'
-
-      # - name: Store benchmark result - separate results repo
-      #   uses: benchmark-action/github-action-benchmark@v1
-      #   with:
-      #     name: Julia benchmark result
-      #     tool: 'julia'
-      #     output-file-path: benchmark/output.json
-      #     # Use personal access token instead of GITHUB_TOKEN due to https://github.community/t/github-action-not-triggering-gh-pages-upon-push/16096
-      #     github-token: ${{ secrets.BENCHMARK_ACTION_BOT_TOKEN }}
-      #     auto-push: true
-      #     # Show alert with commit comment on detecting possible performance regression
-      #     alert-threshold: '200%'
-      #     comment-on-alert: true
-      #     fail-on-alert: false
-      #     #alert-comment-cc-users: '@ktrz,@findmyway'
-      #     gh-repository: 'github.com/benchmark-action/github-action-benchmark-results'
+          gh-pages-branch: main # put in to main so that documenter can build with the data
+          benchmark-data-dir-path: docs/src/bench
+  docs:
+    needs: benchmark # So it can build the page with the results
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1.12'
+      - run: |
+          julia --project=docs -e '
+            import Pkg;
+            Pkg.develop(Pkg.PackageSpec(path=pwd()))
+            Pkg.instantiate()'
+      - run: julia --project=docs docs/make.jl #Pkg.add("Documenter"); using Pkg
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}