Add link checking on CI

[Kobzol]

Soo many broken links 😆

Rendered

[rustbot]

r? @ZuseZ4

rustbot has assigned @ZuseZ4.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

[apiraino]

That's a great work, I didn't realize there were so many of them :/

I would probably also mention in the README to also install cargo install mdbook-linkcheck and run it as part of the contribution. This will hopefully avoid CI surprises to the contributor.

[ehuss]

With the changes in #868, would it make sense to change the "ci" job to only run on deploy? Previously it was there to also run validation on PRs and such.

[Kobzol]

That's a great work, I didn't realize there were so many of them :/

I would probably also mention in the README to also install cargo install mdbook-linkcheck and run it as part of the contribution. This will hopefully avoid CI surprises to the contributor.

Good idea, added.

[ehuss]

With the changes in #868, would it make sense to change the "ci" job to only run on deploy? Previously it was there to also run validation on PRs and such.

In particular, on this, I was thinking the deploy workflow would remove pull_request: from the triggers, since it now is identical to this other workflow (essentially just runs mdbook build). I'm not sure that running two workflows is worthwhile?

It could also remove all of the if: github.ref == 'refs/heads/master' checks, since it would only run on master.

[Kobzol]

Sure, we don't need to run deploy on PRs anymore. I can either do that, or merge both workflows into a single one. Up to you :)

[ehuss]

Sure, we don't need to run deploy on PRs anymore. I can either do that, or merge both workflows into a single one. Up to you :)

Whichever is easier, I don't have a strong preference. Separate workflows seems nice to keep the different use cases separate and avoids some extra if checks, but the main downside is duplicating a little bit of stuff.

[Kobzol]

Ok, simplified the deploy workflow and removed it from PRs.

[ehuss]

Thanks!