pandocs icon indicating copy to clipboard operation
pandocs copied to clipboard

the 'linkcheck' preprocessor should not block the build

Open avivace opened this issue 1 year ago • 4 comments
trafficstars

It often happens that PRs and commits are blocked from being built and pushed because unrelated (in other parts of the document) links now appear to be broken

avivace avatar Sep 12 '24 08:09 avivace

Well, they fail to build, but that doesn't prevent them from being pushed, does it?

ISSOtm avatar Sep 18 '24 17:09 ISSOtm

@ISSOtm it blocks the build so nothing new gets published when a git commit gets pushed

avivace avatar Sep 20 '24 15:09 avivace

Ah, fair.

Solution: split CI into two jobs, one running mdBook without linkcheck and publishing the results; the other running linkcheck.

This will still cause a CI failure, and thus raise red flags (or a red :x:, I guess), but not prevent deployment.

This can be achieved by using environment variables to override the output config, and disable some renderers, I believe.

ISSOtm avatar Sep 21 '24 02:09 ISSOtm

Okay I agree with what you proposed

avivace avatar Sep 21 '24 23:09 avivace