split out doc tests

Author: rukai

.github/workflows/build.yaml

@@ -35,7 +35,7 @@ jobs:
           path: shotover-proxy/build/packages
           key: ubuntu-22.04-packages
       - uses: actions/checkout@v4
-        # We purposefully dont cache here as build_and_test will always be the bottleneck
+        # We purposefully dont cache rust build here as build_and_test will always be the bottleneck
         # so we should leave the cache alone so build_and_test can make more use of it.
       - name: Install ubuntu packages
         run: shotover-proxy/build/install_ubuntu_packages.sh

.github/workflows/build_and_test.yaml

@@ -51,6 +51,10 @@ jobs:
           # downsides:
           # * PRs that update rust version or changes deps will be slow to iterate on due to changes not being cached.
           save-if: ${{ github.ref == 'refs/heads/main' }}
+          # Additionally, the main builds should always run without cache to avoid accumulating unused build files across builds.
+          # Usually, this isnt a problem because rust-cache only caches dependencies, not our project.
+          # However, in this case we have enabled cache-all-crates, which forces rust-cache to cache our projects build files as well as the dependencies.
+          lookup-only: ${{ github.ref == 'refs/heads/main' }}
 
           # Our workspace contains crates like test-helpers that are only changed sometimes,
           # so enabling this gives a nice speedup at the cost of extra cache storage.
@@ -61,7 +65,7 @@ jobs:
       #
       # Note that: evicting this cache without evicting the rust-cache will lead to CI failures, however as long as our caches are well within the 10GB limit we should be fine.
       - name: Cache jassets
-        uses: actions/cache@v5
+        uses: actions/cache/restore@v5
         with:
           path: target/${{ matrix.profile }}/jassets
           # cache can be global as java assets work regardless of OS+arch
@@ -79,9 +83,7 @@ jobs:
         with:
           tool: nextest@0.9.129
       - name: Build tests
-        run: |
-          cargo nextest archive --archive-file nextest-${{ matrix.profile }}.tar.zst ${{ matrix.cargo_flags }} --all-features --all-targets
-          cargo test --doc ${{ matrix.cargo_flags }} --all-features
+        run: cargo nextest archive --archive-file nextest-${{ matrix.profile }}.tar.zst ${{ matrix.cargo_flags }} --all-features --all-targets
       - name: Upload built tests to workflow
         uses: actions/upload-artifact@v4
         with:

.github/workflows/doc_tests.yaml

@@ -0,0 +1,55 @@
+name: cargo doc tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+# Cancel already running jobs
+concurrency:
+  group: doc_tests_${{ github.head_ref }}
+  cancel-in-progress: true
+
+env:
+  CARGO_TERM_COLOR: always
+  RUST_BACKTRACE: 1
+
+jobs:
+  build_check_and_upload:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name: Build Release
+            runner: ubuntu-24.04
+            cargo_flags: --release
+            profile: release
+
+          - name: Build Debug
+            runner: ubuntu-24.04
+            cargo_flags:
+            profile: debug
+
+    name: ${{ matrix.name }}
+    runs-on: ${{ matrix.runner }}
+    steps:
+      - uses: actions/checkout@v4
+      # We purposefully dont cache rust build here as build_and_test will always be the bottleneck
+      # so we should leave the cache alone so build_and_test can make more use of it.
+      - name: cache custom ubuntu packages
+        uses: actions/cache@v5
+        with:
+          path: shotover-proxy/build/packages
+          key: ubuntu-24.04-packages
+      - name: Install ubuntu packages
+        run: shotover-proxy/build/install_ubuntu_packages.sh
+      - name: run doc tests
+        run: |
+          cargo test --doc ${{ matrix.cargo_flags }} --all-features
+      - name: Ensure that tests did not create or modify any files that arent .gitignore'd
+        run: |
+          if [ -n "$(git status --porcelain)" ]; then
+            git status
+            exit 1
+          fi