search

scipp / copier_template

Copier template for Scipp projects
BSD 3-Clause "New" or "Revised" License
2 stars 1 forks source link

Toggle option to run linkchecker when building docs #112

Closed jokasimr closed 10 months ago

jokasimr commented 10 months ago

Fixes #109

Is this the way we want to do it? Should the link checker also be enabled when building docs in the release workflow?

SimonHeybrock commented 10 months ago

No, see https://github.com/scipp/copier_template/issues/109#issuecomment-1833204517.

And we definitely do not want to lose the ability to make a release, just because some site we link to is temporarily down. We should not run linkcheck in release builds.

jokasimr commented 10 months ago

No, see #109 (comment).

And we definitely do not want to lose the ability to make a release, just because some site we link to is temporarily down. We should not run linkcheck in release builds.

Makes sense. However, I don't understand why this change would prevent us from making a release? I thought this would only activate the linkchecker in PRs?

Then again, maybe we don't even want to have the link checker in PRs.

SimonHeybrock commented 10 months ago

However, I don't understand why this change would prevent us from making a release?

Not saying that it would. I was answering the question in your PR message ("Should the link checker also be enabled when building docs in the release workflow?")