Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 2 commits into from
Aug 22, 2024
Merged

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

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4fad20a
Expand the introduction to the contents of the CI folder
gancerlory Aug 14, 2024
1d89619
Update docs/repo/ci.md
gancerlory Aug 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions docs/repo/ci.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
gancerlory marked this conversation as resolved.
Show resolved Hide resolved

### 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
Loading