Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add make linkcheck step, to check external links [#29] #104

Merged
merged 1 commit into from
Aug 20, 2024

Conversation

genehack
Copy link
Contributor

@genehack genehack commented Aug 5, 2024

Description of proposed changes

Adds a make linkcheck step to the Sphinx CI.

Note that this blocks on the various PRs attached to nextstrain/docs.nextstrain.org#14 — those PRs should be merged before this one.

Update to add: I realized this workflow is used by more than docs.nextstrain.org, so before this can be merged, the following repos need to be audited for broken links:

Related issue(s)

Closes #29
nextstrain/docs.nextstrain.org#14

Checklist

  • Checks pass

Copy link
Contributor

@joverlee521 joverlee521 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we'd want to add the new make linkcheck step the the build-conda job as well?

...to check external links

Note that this blocks on the various PRs attached to
nextstrain/docs.nextstrain.org/#14 — those PRs should be merged before
this one.
@genehack
Copy link
Contributor Author

genehack commented Aug 6, 2024

I think we'd want to add the new make linkcheck step the the build-conda job as well?

Good call, done.

Also removed env-var and adjusted use of make-target.

@genehack
Copy link
Contributor Author

genehack commented Aug 6, 2024

Updated description above to note that before this can land, everything that uses it (listed above) needs to be manually audited to get make linkcheck to run cleanly. Links to open issues above.

@genehack
Copy link
Contributor Author

This is now ready to merge — all the affected downstream repos should have clean make linkcheck runs in their doc trees — but I'm going to wait until Monday to actually push the button, just in case something goes pear-shaped after all.

@genehack
Copy link
Contributor Author

This is now ready to merge — all the affected downstream repos should have clean make linkcheck runs in their doc trees — but I'm going to wait until Monday to actually push the button, just in case something goes pear-shaped after all.

I also validated a branch in each of the five repos that consume this PI action, changing docs-ci.yaml to point to this branch, and verifying that the CI remained green.

@genehack genehack merged commit 654db55 into master Aug 20, 2024
44 checks passed
@genehack genehack deleted the check-external-links-29 branch August 20, 2024 23:13
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.

docs-ci: Check external links
3 participants