You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Mar 7, 2024. It is now read-only.
Clearly the documentation should always be buildable, but sometimes people break it anyway; of course when making a release, this becomes evident, but it is desirable to notice this immediately.
Hence it would be good to test that, at least for packages using makedoc.g. It is potentially problematic to just always do that (as running makedoc.g might have additional effects for some packages, and thus cause issues); also, if a package's makedoc.g requires a recent AutoDoc version, it may e.g. fail in the stable-4.9 branch.
I see two ways to proceed:
Opt-In: we add a way for a package author to specify that makedoc.g is supposed to be tested in one specific build, probably by checking for a new env var, like TEST_MAKEDOC=yes
Opt-out: always test for makedoc.g, unless TEST_MAKEDOC=no is specified (possibly with some restrictions: e.g. we might want to limit this to builds on master)
The advantage of 1 is that it won't unexpectedly break any package's test suite. The drawback is that now every package needs to opt-in to benefit.
The text was updated successfully, but these errors were encountered:
Clearly the documentation should always be buildable, but sometimes people break it anyway; of course when making a release, this becomes evident, but it is desirable to notice this immediately.
Hence it would be good to test that, at least for packages using
makedoc.g
. It is potentially problematic to just always do that (as runningmakedoc.g
might have additional effects for some packages, and thus cause issues); also, if a package'smakedoc.g
requires a recent AutoDoc version, it may e.g. fail in thestable-4.9
branch.I see two ways to proceed:
makedoc.g
is supposed to be tested in one specific build, probably by checking for a new env var, likeTEST_MAKEDOC=yes
makedoc.g
, unlessTEST_MAKEDOC=no
is specified (possibly with some restrictions: e.g. we might want to limit this to builds onmaster
)The advantage of 1 is that it won't unexpectedly break any package's test suite. The drawback is that now every package needs to opt-in to benefit.
The text was updated successfully, but these errors were encountered: