CI does not build rustdoc for all crates

[wfdewith]

Currently, the GitHub action runs cargo doc --all-features --no-deps in the repository root to build the documentation for LibAFL. Unfortunately, this does not build documentation for all crates in the Cargo workspace, only for the crates referred in default-members.

We could include all workspace crates by adding --workspace to the cargo doc command. However, many of the crates that aren't included currently use mutually exclusive features extensively. This means that cargo doc --all-features --no-deps --workspace causes all kinds of errors, for example for duplicate definitions of structs.

I'm not sure what the best approach is here. Removing --all-features seems heavy-handed and would also skip docs for a lot of code. Keeping the situation as it is does not seem right either, considering the docs for LibAFL 0.15.4 do not build at all at the moment.

[domenukk]

Ooh... Nice find!
We historically solved this by having an extra feature like clippy that then overrides breakages. We could do a docs feature that does the same (or reuse clippy), what do you think?

[wfdewith]

I think the easiest solution would be to copy what scripts/clippy.sh does for clippy. Just have a list of projects for which cargo doc must succeed (i.e. every crate that is published), and disable --all-features for some of them, and make this a runnable script in scripts/doc.sh.

However, while I was looking into this, it struck me that there is quite a bit of ad-hoc configuration in scripts for certain crates to perform actions (publish, clippy, etc.) with special requirements. Considering the heavy use of just in this repository already, wouldn't it make sense to move the top level tasks into a single Justfile in the repository root? We could then put a Justfile in every crate to define tasks like clippy and doc. This would leave the special requirements for each crate closer to the actual crate, which would make it easier to refactor crates etc.

[domenukk]

You mean similar to #3099? :D Yes would make sense.

[domenukk]

Sadly it's a lot of work... Maybe with an LLM it'd be faster