Skip to content

Run docs CI on Augur code changes#2002

Closed
victorlin wants to merge 1 commit into
masterfrom
victorlin/update-docs-paths
Closed

Run docs CI on Augur code changes#2002
victorlin wants to merge 1 commit into
masterfrom
victorlin/update-docs-paths

Conversation

@victorlin
Copy link
Copy Markdown
Member

@victorlin victorlin commented May 19, 2026

Description of proposed changes

As noted in the commit message of "[export] fix incorrect type def" (9d178e5), the invalid type definition introduced in "[minor] refactor config transfer functions for export" (5981840) did not surface the failure until another PR touched docs-related files.

This will result in unnecessary runs for code changes that don't touch docstrings, but that's fine and was already the case before splitting docs CI into its own workflow.

Related issue(s)

Follow-up to 9d178e5

Checklist

  • Automated checks pass
  • Check if you need to add a changelog message
  • Check if you need to add tests
  • Check if you need to update docs

As noted in the commit message of "[export] fix incorrect type def"
(9d178e5), the invalid type definition introduced in "[minor] refactor
config transfer functions for export" (5981840) did not surface the
failure until another PR touched docs-related files.

This will result in unnecessary runs for code changes that don't touch
docstrings, but that's fine and was already the case before splitting
docs CI into its own workflow.
Comment thread .github/workflows/docs.yaml
@jameshadfield
Copy link
Copy Markdown
Member

I've come to accept that I'll never remember which language uses string and which one uses str, and I just have to rely on my IDE / CI / linting etc to correct me.

joverlee521 added a commit to nextstrain/cli that referenced this pull request May 20, 2026
Paths were initially added to reduce noise from docs-ci due to linkcheck.
We can now run docs-ci on every push/PR since we only include linkcheck
on scheduled runs. This ensures that we capture doc changes that come
from the source code similar to <nextstrain/augur#2002>
joverlee521 added a commit to nextstrain/auspice that referenced this pull request May 20, 2026
Paths were initially added to reduce noise from docs-ci due to linkcheck.
We can now run docs-ci on every push/PR since we only include linkcheck
on scheduled runs. 

Based on discussion in
<nextstrain/augur#2002 (comment)>
joverlee521 added a commit to nextstrain/ncov that referenced this pull request May 20, 2026
Paths were initially added to reduce noise from docs-ci due to linkcheck.
We can now run docs-ci on every push/PR since we only include linkcheck
on scheduled runs.

Based on discussion in
<nextstrain/augur#2002 (comment)>
@joverlee521
Copy link
Copy Markdown
Contributor

Closing in favor of #2004

@joverlee521 joverlee521 deleted the victorlin/update-docs-paths branch May 20, 2026 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants