Move doctests into separate workflow

Author: penelopeysm

.github/workflows/DocTest.yml

@@ -0,0 +1,59 @@
+# We want to only run doctests on a single version of Julia, because
+# things like error messages / output can change between versions and
+# is fragile to test against.
+name: Doctests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  merge_group:
+    types: [checks_requested]
+
+# needed to allow julia-actions/cache to delete old caches that it has created
+permissions:
+  actions: write
+  contents: read
+
+# Cancel existing tests on the same PR if a new commit is added to a pull request
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref || github.run_id }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1'
+
+      - uses: julia-actions/cache@v2
+
+      - uses: julia-actions/julia-buildpkg@v1
+
+      - name: Run doctests
+        shell: julia --color=yes --project=docs {0}
+        run: |
+          # Develop currently checked out version of DynamicPPL
+          using Pkg
+          Pkg.develop(path=pwd())
+
+          using Documenter
+          DocMeta.setdocmeta!(
+              DynamicPPL,
+              :DocTestSetup,
+              :(using DynamicPPL, Distributions);
+              recursive=true,
+          )
+          doctestfilters = [
+              # Ignore the source of a warning in the doctest output, since this is dependent on host.
+              # This is a line that starts with "└ @ " and ends with the line number.
+              r"└ @ .+:[0-9]+",
+          ]
+
+          doctest(DynamicPPL; manual=false, doctestfilters=doctestfilters)

test/Project.toml

@@ -11,7 +11,6 @@ DifferentiationInterface = "a0c0ee7d-e4b9-4e03-894e-1c5f64a51d63"
 Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b"
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
 DistributionsAD = "ced4e74d-a319-5a8a-b0ac-84af2272839c"
-Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 EnzymeCore = "f151be2c-9106-41f4-ab19-57ee4f262869"
 ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
 JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
@@ -40,7 +39,6 @@ Compat = "4.3.0"
 DifferentiationInterface = "0.6.41"
 Distributions = "0.25"
 DistributionsAD = "0.6.3"
-Documenter = "1"
 EnzymeCore = "0.6 - 0.8"
 ForwardDiff = "0.10.12"
 JET = "0.9, 0.10"

test/runtests.jl

@@ -7,7 +7,6 @@ using Bijectors
 using DifferentiationInterface
 using Distributions
 using DistributionsAD
-using Documenter
 using ForwardDiff
 using LogDensityProblems
 using MacroTools
@@ -97,22 +96,5 @@ include("test_util.jl")
             @test_throws ErrorException prob"..."
             @test_throws ErrorException logprob"..."
         end
-        if !IS_PRERELEASE
-            # Don't run doctests on prerelease as error messages etc. may vary
-            @testset "doctests" begin
-                DocMeta.setdocmeta!(
-                    DynamicPPL,
-                    :DocTestSetup,
-                    :(using DynamicPPL, Distributions);
-                    recursive=true,
-                )
-                doctestfilters = [
-                    # Ignore the source of a warning in the doctest output, since this is dependent on host.
-                    # This is a line that starts with "└ @ " and ends with the line number.
-                    r"└ @ .+:[0-9]+",
-                ]
-                doctest(DynamicPPL; manual=false, doctestfilters=doctestfilters)
-            end
-        end
     end
 end