diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index b293eaf57..a92ecfe53 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -163,8 +163,10 @@ jobs: build-docs: # When running on a PR, this just checks we can build the docs without errors # When running on merge to main, it builds the docs and then another job deploys them - name: ${{ github.event_name == 'pull_request' && 'Check Build Docs' || 'Build Docs' }} + name: 'Build Docs' runs-on: ubuntu-latest + if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev') + needs: code-checks steps: - uses: actions/checkout@v4 - name: Install Poetry @@ -181,6 +183,11 @@ jobs: version: 1.0 - name: Install dependencies run: poetry install --with docs + - name: Download Test Coverage Artifact + uses: actions/download-artifact@v3 + with: + name: test-coverage + path: docs/source/_static/coverage - name: Build Docs run: poetry run build-docs env: @@ -196,7 +203,7 @@ jobs: runs-on: ubuntu-latest # Only run if merging a PR into main if: github.event_name == 'push' && github.ref == 'refs/heads/main' - needs: [build-docs, code-checks] + needs: build-docs steps: - uses: actions/checkout@v4 - name: Download Docs Artifact @@ -204,11 +211,6 @@ jobs: with: name: documentation path: docs/build - - name: Download Test Coverage Artifact - uses: actions/download-artifact@v3 - with: - name: test-coverage - path: docs/build/coverage - name: Upload to GitHub Pages uses: JamesIves/github-pages-deploy-action@v4 with: diff --git a/docs/source/index.md b/docs/source/index.md index 59eb36fae..2eb9bbd92 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -52,6 +52,6 @@ content/special_cases :caption: Development content/contributing -Code Coverage <./coverage/index.html#http://> +Code Coverage Github ```