Skip to content
This repository has been archived by the owner on Mar 7, 2024. It is now read-only.

Add a way to easily test that makedoc.g works #5

Open
fingolfin opened this issue Sep 3, 2019 · 1 comment
Open

Add a way to easily test that makedoc.g works #5

fingolfin opened this issue Sep 3, 2019 · 1 comment

Comments

@fingolfin
Copy link
Member

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:

  1. 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
  2. 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.

@fingolfin
Copy link
Member Author

With GitHub Actions, this is taken care of by https://github.com/gap-actions/build-pkg-docs

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant