CI / CD Setup

[boorich]

Investigate Forest's CI / CD and implement what makes sense from the list:

• [ ] audit (security vulnerabilities)
• [ ] taplo (TOML files linting)
• [ ] spellcheck
• [ ] mdbook-linkcheck (checks for broken links)
• [ ] udeps (unused dependencies)
• [ ] nextest (drop-in replacement for test runner, makes it easy to spot bottlenecks and runs faster than the standard tool)
• [ ] quickinstall (faster installation for well-known cargo plugins)
• [ ] caching mechanisms
• [ ] shellcheck (not Rust-specific but it's cheap to add it and most projects end up with some shell scripts anyway)

On top of this, snatching the license script might be helpful.

[stonecharioteer]

@LesnyRumcajs recommended incorporating some of the checks that chainsafe/forest uses.

[LesnyRumcajs]

I find it beneficial to create several repositories for such a large project for clear boundaries and to enforce a more modular design. For this reason, I would recommend working on rust-template or forking this template for filix with a set of agreed CI checks.

Forest project is an excellent source of inspiration when it comes to CI. Some parts I would recommend:

• audit (security vulnerabilities),
• taplo (TOML files linting),
• spellcheck,
• mdbook-linkcheck (checks for broken links),
• udeps (unused dependencies),
• nextest (drop-in replacement for test runner, makes it easy to spot bottlenecks and runs faster than the standard tool),
• quickinstall (faster installation for well-known cargo plugins).
• caching mechanisms,
• shellcheck (not Rust-specific but it's cheap to add it and most projects end up with some shell scripts anyway)

On top of this, snatching the license script might be helpful.

[stonecharioteer]

Agree with everything, just wanted to say shellcheck taught me more about bash than any other tutorial/resource.