ci: split ci workflow (#1345)

This commit is contained in:
Bjerg
2023-02-14 17:49:18 +01:00
committed by GitHub
parent d216081b58
commit f63c8d7e36
14 changed files with 343 additions and 197 deletions

View File

@ -4,6 +4,7 @@ This directory contains documentation for contributors.
- [Repository and Project Structure](./repo)
- [Design](./design)
- [Crates](./crates)
### Meta

9
docs/crates/README.md Normal file
View File

@ -0,0 +1,9 @@
## Crates
A tour of the various crates that make up reth.
- [`reth-db`](./db.md)
- [`reth-discv4`](./discv4.md)
- [`reth-eth-wire`](./eth-wire.md)
- [`reth-network`](./network.md)
- [`reth-stages`](./stages.md)

View File

@ -9,3 +9,4 @@ Documents on planning and process in the repository: what the labels mean, how i
### Structure
- [Layout](./layout.md): Describes each of the crates in the repository and their function.
- [CI](./ci.md): An overview of the CI workflows

32
docs/repo/ci.md Normal file
View File

@ -0,0 +1,32 @@
## CI
The CI runs a couple of workflows:
### Code
- **[ci]**: A catch-all for small jobs. Currently only runs lints (rustfmt, clippy etc.)
- **[unit]**: Runs unit tests (tests in `src/`) and doc tests
- **[integration]**: Runs integration tests (tests in `tests/` and sync tests)
- **[fuzz]**: Runs fuzz tests
- **[bench]**: Runs benchmarks
### Docs
- **[book]**: Builds, tests, and deploys the book.
### Meta
- **[deny]**: Runs `cargo deny` to check for license conflicts and security advisories in our dependencies
- **[sanity]**: Runs a couple of sanity checks on the code every night, such as checking for unused dependencies
- **[project]**: [GitHub Projects][gh-projects] automation.
[ci]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/ci.yml
[unit]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/unit.yml
[integration]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/integration.yml
[fuzz]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/fuzz.yml
[bench]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/bench.yml
[book]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/book.yml
[deny]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/deny.yml
[sanity]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/sanity.yml
[project]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/project.yml
[gh-projects]: https://docs.github.com/en/issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions