From 4fad20a2419ab7ea1518bf9ed500780c71775f20 Mon Sep 17 00:00:00 2001 From: gancerlory Date: Wed, 14 Aug 2024 15:27:19 +0800 Subject: [PATCH 1/2] Expand the introduction to the contents of the CI folder --- docs/repo/ci.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/docs/repo/ci.md b/docs/repo/ci.md index d69e12c5d3a5..291403436888 100644 --- a/docs/repo/ci.md +++ b/docs/repo/ci.md @@ -7,6 +7,9 @@ The CI runs a couple of workflows: - **[unit]**: Runs unit tests (tests in `src/`) and doc tests - **[integration]**: Runs integration tests (tests in `tests/` and sync tests) - **[bench]**: Runs benchmarks +- **[eth-sync]**: Runs Ethereum mainnet sync tests +- **[op-sync]**: Runs base mainnet sync tests for Optimism +- **[stage]**: Runs all `stage run` commands ### Docs @@ -16,10 +19,37 @@ The CI runs a couple of workflows: - **[deny]**: Runs `cargo deny` to check for license conflicts and security advisories in our dependencies - **[release]**: Runs the release workflow +- **[release-dist]**: Publishes Reth to external package managers +- **[dependencies]**: Runs `cargo update` periodically to keep dependencies current +- **[stale]**: Marks issues as stale if there has been no activity + +### Maintenance + +- **[docker]**: Publishes the Docker image. +- **[assertoor]**: Runs Assertoor tests on Reth pairs. +- **[hive]**: Runs `ethereum/hive` tests. + +### Linting and Checks + +- **[lint]**: Lints code using `cargo clippy` and other checks +- **[lint-actions]**: Lints GitHub Actions workflows +- **[label-pr]**: Automatically labels PRs [unit]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/unit.yml [integration]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/integration.yml [bench]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/bench.yml +[eth-sync]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/eth-sync.yml +[op-sync]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/op-sync.yml +[stage]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/stage.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 [release]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/release.yml +[release-dist]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/release-dist.yml +[dependencies]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/dependencies.yml +[stale]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/stale.yml +[docker]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/docker.yml +[assertoor]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/assertoor.yml +[hive]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/hive.yml +[lint]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/lint.yml +[lint-actions]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/lint-actions.yml +[label-pr]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/label-pr.yml From 1d896194e1f5b6b54908fae6b6badcc58a81734b Mon Sep 17 00:00:00 2001 From: gancerlory Date: Fri, 23 Aug 2024 00:10:43 +0800 Subject: [PATCH 2/2] Update docs/repo/ci.md Co-authored-by: Dan Cline <6798349+Rjected@users.noreply.github.com> --- docs/repo/ci.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/repo/ci.md b/docs/repo/ci.md index 291403436888..da84e001f376 100644 --- a/docs/repo/ci.md +++ b/docs/repo/ci.md @@ -22,10 +22,10 @@ The CI runs a couple of workflows: - **[release-dist]**: Publishes Reth to external package managers - **[dependencies]**: Runs `cargo update` periodically to keep dependencies current - **[stale]**: Marks issues as stale if there has been no activity +- **[docker]**: Publishes the Docker image. -### Maintenance +### Integration Testing -- **[docker]**: Publishes the Docker image. - **[assertoor]**: Runs Assertoor tests on Reth pairs. - **[hive]**: Runs `ethereum/hive` tests.