Skip to content

Split make linkcheck out into a distinct job [#106]#107

Closed
genehack wants to merge 1 commit intomasterfrom
make-linkcheck-fails-ok-106
Closed

Split make linkcheck out into a distinct job [#106]#107
genehack wants to merge 1 commit intomasterfrom
make-linkcheck-fails-ok-106

Conversation

@genehack
Copy link
Copy Markdown
Contributor

@genehack genehack commented Sep 3, 2024

Description of proposed changes

Split make linkcheck into a distinct job, with continue-on-error: true, so that transient failures don't show as CI fails.

Related issue(s)

Closes #106

Checklist

  • Checks pass

@genehack genehack force-pushed the make-linkcheck-fails-ok-106 branch 3 times, most recently from 4d7062b to 9fbfaea Compare September 3, 2024 22:25
@genehack genehack requested a review from victorlin September 3, 2024 22:52
Comment on lines +88 to +87
linkcheck:
if: inputs.pip-install-target != ''
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This prevents linkcheck from running on conda-based build environments. It should be split into linkcheck-conda and linkcheck-pip.

Another approach would be what @tsibley proposed in #28 (review). This would allow for a single job to handle both conda and pip, but it's more complex:

My idea had been to make this workflow read the RTD config file and install what's configured there, which I still think would be nicer, but it's more complex.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This prevents linkcheck from running on conda-based build environments. It should be split into linkcheck-conda and linkcheck-pip.

I don't see the utility of running the exact same linkcheck process twice — that's just going to cause additional fails due to random network glitches.

In what scenario does a link resolve in the conda build and fail to resolve in the pip build, or vice versa?

Copy link
Copy Markdown
Member

@victorlin victorlin Sep 4, 2024

Choose a reason for hiding this comment

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

build-conda and build-pip are meant to be mutually exclusive, and the same would go for linkcheck-conda/linkcheck-pip. This is not checked in the workflow because it's reasonable to assume that a docs project will use only one. See GitHub query org:nextstrain nextstrain/.github/.github/workflows/docs-ci.yaml: some invocations specify environment-file while others specify pip-install-target.

Comment thread .github/workflows/docs-ci.yaml Outdated
@victorlin
Copy link
Copy Markdown
Member

Closing this in favor of #110 as a solution to #106

@victorlin victorlin closed this Oct 16, 2024
@victorlin victorlin deleted the make-linkcheck-fails-ok-106 branch October 16, 2024 17:51
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: make linkcheck prone to transient network failures

2 participants