jleony/nanoreth
1
0
Fork 0
mirror of https://github.com/hl-archive-node/nanoreth.git synced 2025-12-06 10:59:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(ci): expand introduction to CI workflows (#10291)

Browse Source 
Co-authored-by: Dan Cline <6798349+Rjected@users.noreply.github.com>
This commit is contained in:
gancerlory
2024-08-23 01:07:34 +08:00
committed by GitHub
parent 85c1c07629
commit ed6ee0c04b
1 changed files with 30 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/repo/ci.md
View File

@ -7,6 +7,9 @@ The CI runs a couple of workflows:
- **[unit]**: Runs unit tests (tests in `src/`) and doc tests - **[unit]**: Runs unit tests (tests in `src/`) and doc tests
- **[integration]**: Runs integration tests (tests in `tests/` and sync tests) - **[integration]**: Runs integration tests (tests in `tests/` and sync tests)
- **[bench]**: Runs benchmarks - **[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 ### 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 - **[deny]**: Runs `cargo deny` to check for license conflicts and security advisories in our dependencies
- **[release]**: Runs the release workflow - **[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
- **[docker]**: Publishes the Docker image.
### Integration Testing
- **[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 [unit]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/unit.yml
[integration]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/integration.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 [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 [book]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/book.yml
[deny]: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/deny.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]: 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