Skip to content

Commit d17da3d

Browse files
committed
Only run docs CI on schedule or code change
Previously, docs CI was run on every code change, even when docs were untouched. This tended to generate noise with many false positives. Scheduled runs still catch when any existing links break, but at a weekly frequency so that any false positives are less noisy.
1 parent 7f5c231 commit d17da3d

2 files changed

Lines changed: 29 additions & 7 deletions

File tree

.github/workflows/ci.yaml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -345,13 +345,6 @@ jobs:
345345

346346
- uses: ./src/.github/actions/run-integration-tests
347347

348-
doc:
349-
uses: nextstrain/.github/.github/workflows/docs-ci.yaml@master
350-
with:
351-
docs-directory: doc/
352-
pip-install-target: .[dev]
353-
make-target: dirhtml
354-
355348
release:
356349
# Restricted to version tags by the "on: push: tags: …" config at the top.
357350
if: |2

.github/workflows/docs.yaml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
paths:
8+
- doc/**
9+
- .github/workflows/docs.yaml
10+
11+
pull_request:
12+
paths:
13+
- doc/**
14+
- .github/workflows/docs.yaml
15+
16+
workflow_dispatch:
17+
18+
# Routinely check that we continue to work in the face of external changes.
19+
schedule:
20+
# Every Monday at 17:42 UTC / 9:42 Seattle (winter) / 10:42 Seattle (summer)
21+
- cron: "42 17 * * 1"
22+
23+
jobs:
24+
ci:
25+
uses: nextstrain/.github/.github/workflows/docs-ci.yaml@master
26+
with:
27+
docs-directory: doc/
28+
pip-install-target: .[dev]
29+
make-target: dirhtml

0 commit comments

Comments
 (0)