Create mdbook.yml by Dargon789 · Pull Request #28 · Dargon789/reth

Dargon789 · 2026-04-19T21:44:59Z

Summary by Sourcery

Add a GitHub Actions workflow to build and deploy the mdBook site to GitHub Pages on pushes to the main branch.

CI:

Introduce a GitHub Actions workflow that builds the mdBook project and uploads the generated site as a Pages artifact on pushes to main.

Deployment:

Configure automated deployment of the mdBook-generated site to GitHub Pages using a dedicated workflow.

…2738) (#5) * ci(bench): add Wall Clock Time metric to results table (paradigmxyz#22738) Co-authored-by: Alexey Shekhirin <5773434+shekhirin@users.noreply.github.com> * fix: skip persisted peers without a confirmed fork ID on startup (paradigmxyz#22734) * fix(grafana): use correct metric for block buffer blocks panel (paradigmxyz#22741) Co-authored-by: Brian Picciano <933154+mediocregopher@users.noreply.github.com> * feat(metrics): add /debug/tokio/dump endpoint for tokio task dumps (paradigmxyz#22737) Co-authored-by: Alexey Shekhirin <5773434+shekhirin@users.noreply.github.com> * perf(net): increase default concurrent outbound dials to 30 (paradigmxyz#22744) Co-authored-by: Amp <amp@ampcode.com> --------- Co-authored-by: Derek Cofausper <256792747+decofe@users.noreply.github.com> Co-authored-by: Alexey Shekhirin <5773434+shekhirin@users.noreply.github.com> Co-authored-by: Emma Jamieson-Hoare <emmajam@users.noreply.github.com> Co-authored-by: Brian Picciano <933154+mediocregopher@users.noreply.github.com> Co-authored-by: Matthias Seitz <matthias.seitz@outlook.de> Co-authored-by: Amp <amp@ampcode.com>

Bumps [actions/checkout](https://github.com/actions/checkout) from 4 to 6. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v4...v6) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: '6' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [actions/download-artifact](https://github.com/actions/download-artifact) from 7 to 8. - [Release notes](https://github.com/actions/download-artifact/releases) - [Commits](actions/download-artifact@v7...v8) --- updated-dependencies: - dependency-name: actions/download-artifact dependency-version: '8' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 6 to 7. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](actions/upload-artifact@v6...v7) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-version: '7' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps the cargo-weekly group with 5 updates: | Package | From | To | | --- | --- | --- | | [alloy-eip7928](https://github.com/alloy-rs/eips) | `0.3.2` | `0.3.3` | | [moka](https://github.com/moka-rs/moka) | `0.12.13` | `0.12.14` | | [sysinfo](https://github.com/GuillaumeGomez/sysinfo) | `0.38.2` | `0.38.3` | | [tracing-logfmt](https://github.com/EmbarkStudios/tracing-logfmt) | `0.3.5` | `0.3.7` | | [ipnet](https://github.com/krisprice/ipnet) | `2.11.0` | `2.12.0` | Updates `alloy-eip7928` from 0.3.2 to 0.3.3 - [Changelog](https://github.com/alloy-rs/eips/blob/main/CHANGELOG.md) - [Commits](alloy-rs/eips@alloy-eip7928-v0.3.2...alloy-eip7928-v0.3.3) Updates `moka` from 0.12.13 to 0.12.14 - [Release notes](https://github.com/moka-rs/moka/releases) - [Changelog](https://github.com/moka-rs/moka/blob/main/CHANGELOG.md) - [Commits](moka-rs/moka@v0.12.13...v0.12.14) Updates `sysinfo` from 0.38.2 to 0.38.3 - [Changelog](https://github.com/GuillaumeGomez/sysinfo/blob/main/CHANGELOG.md) - [Commits](GuillaumeGomez/sysinfo@v0.38.2...v0.38.3) Updates `tracing-logfmt` from 0.3.5 to 0.3.7 - [Release notes](https://github.com/EmbarkStudios/tracing-logfmt/releases) - [Changelog](https://github.com/EmbarkStudios/tracing-logfmt/blob/main/CHANGELOG.md) - [Commits](EmbarkStudios/tracing-logfmt@0.3.5...0.3.7) Updates `ipnet` from 2.11.0 to 2.12.0 - [Release notes](https://github.com/krisprice/ipnet/releases) - [Changelog](https://github.com/krisprice/ipnet/blob/master/RELEASES.md) - [Commits](krisprice/ipnet@2.11.0...2.12.0) --- updated-dependencies: - dependency-name: alloy-eip7928 dependency-version: 0.3.3 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: cargo-weekly - dependency-name: moka dependency-version: 0.12.14 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: cargo-weekly - dependency-name: sysinfo dependency-version: 0.38.3 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: cargo-weekly - dependency-name: tracing-logfmt dependency-version: 0.3.7 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: cargo-weekly - dependency-name: ipnet dependency-version: 2.12.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: cargo-weekly ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Dargon789 <64915515+Dargon789@users.noreply.github.com>

* Update issue templates * Update .github/ISSUE_TEMPLATE/bug_report.md Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com> Signed-off-by: Dargon789 <64915515+Dargon789@users.noreply.github.com> * Update .github/ISSUE_TEMPLATE/bug_report.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Dargon789 <64915515+Dargon789@users.noreply.github.com> --------- Signed-off-by: Dargon789 <64915515+Dargon789@users.noreply.github.com> Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Bumps [docker/build-push-action](https://github.com/docker/build-push-action) from 6 to 7. - [Release notes](https://github.com/docker/build-push-action/releases) - [Commits](docker/build-push-action@v6...v7) --- updated-dependencies: - dependency-name: docker/build-push-action dependency-version: '7' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [docker/setup-buildx-action](https://github.com/docker/setup-buildx-action) from 3 to 4. - [Release notes](https://github.com/docker/setup-buildx-action/releases) - [Commits](docker/setup-buildx-action@v3...v4) --- updated-dependencies: - dependency-name: docker/setup-buildx-action dependency-version: '4' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [docker/bake-action](https://github.com/docker/bake-action) from 6 to 7. - [Release notes](https://github.com/docker/bake-action/releases) - [Commits](docker/bake-action@v6...v7) --- updated-dependencies: - dependency-name: docker/bake-action dependency-version: '7' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [quinn-proto](https://github.com/quinn-rs/quinn) from 0.11.13 to 0.11.14. - [Release notes](https://github.com/quinn-rs/quinn/releases) - [Commits](quinn-rs/quinn@quinn-proto-0.11.13...quinn-proto-0.11.14) --- updated-dependencies: - dependency-name: quinn-proto dependency-version: 0.11.14 dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Dargon789 <64915515+Dargon789@users.noreply.github.com>

Bumps [docker/login-action](https://github.com/docker/login-action) from 3 to 4. - [Release notes](https://github.com/docker/login-action/releases) - [Commits](docker/login-action@v3...v4) --- updated-dependencies: - dependency-name: docker/login-action dependency-version: '4' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [lz4_flex](https://github.com/pseitz/lz4_flex) from 0.12.0 to 0.12.1. - [Release notes](https://github.com/pseitz/lz4_flex/releases) - [Changelog](https://github.com/PSeitz/lz4_flex/blob/main/CHANGELOG.md) - [Commits](PSeitz/lz4_flex@0.12.0...0.12.1) --- updated-dependencies: - dependency-name: lz4_flex dependency-version: 0.12.1 dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [tracing-subscriber](https://github.com/tokio-rs/tracing) from 0.3.22 to 0.3.23. - [Release notes](https://github.com/tokio-rs/tracing/releases) - [Commits](tokio-rs/tracing@tracing-subscriber-0.3.22...tracing-subscriber-0.3.23) --- updated-dependencies: - dependency-name: tracing-subscriber dependency-version: 0.3.23 dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Signed-off-by: Dargon789 <64915515+Dargon789@users.noreply.github.com>

gemini-code-assist · 2026-04-19T21:45:04Z

Note

Gemini is unable to generate a review for this pull request due to the file types involved not being currently supported.

sourcery-ai · 2026-04-19T21:45:05Z

Reviewer's Guide

Adds a new GitHub Actions workflow to build an mdBook project and deploy it to GitHub Pages on pushes to main or manual dispatch.

Flow diagram for mdBook GitHub Actions workflow jobs and steps

flowchart TD
  A[Trigger
  push to main
  or workflow_dispatch]
  B[Job build
  runs-on ubuntu-latest]
  C[Step
  actions/checkout@v4]
  D[Step
  Install mdBook
  - install rustup
  - rustup update
  - cargo install mdbook 0.4.36]
  E[Step
  actions/configure-pages@v5
  id pages]
  F[Step
  mdbook build]
  G[Step
  actions/upload-pages-artifact@v3
  path ./book]
  H[Job deploy
  environment github-pages
  needs build]
  I[Step
  actions/deploy-pages@v5
  id deployment]

  A --> B
  B --> C --> D --> E --> F --> G --> H --> I

File-Level Changes

Change	Details	Files
Introduce GitHub Actions workflow to build and deploy mdBook site to GitHub Pages.	Configure workflow triggers on pushes to main and manual workflow_dispatch. Set appropriate GITHUB_TOKEN permissions and deployment concurrency for Pages deployments. Add build job that checks out the repo, installs a specific mdBook version via Rust toolchain and cargo, configures GitHub Pages, builds the book, and uploads the build artifact from ./book. Add deploy job that depends on the build job and publishes the uploaded artifact to GitHub Pages using actions/deploy-pages@v5, exposing the deployed page URL via the environment configuration.	`.github/workflows/mdbook.yml`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey - I've found 1 issue, and left some high level feedback:

The rustup installation command looks incorrect (-y is currently being passed to curl instead of the install script); consider using the standard form curl ... | sh -s -- -y so the installer runs non-interactively as intended.
Installing a full Rust toolchain on every run just to get mdbook is quite heavy; you may want to switch to downloading a prebuilt mdBook binary or using a reusable action to reduce build time and complexity.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- The rustup installation command looks incorrect (`-y` is currently being passed to curl instead of the install script); consider using the standard form `curl ... | sh -s -- -y` so the installer runs non-interactively as intended.
- Installing a full Rust toolchain on every run just to get `mdbook` is quite heavy; you may want to switch to downloading a prebuilt mdBook binary or using a reusable action to reduce build time and complexity.

## Individual Comments

### Comment 1
<location path=".github/workflows/mdbook.yml" line_range="35-39" />
<code_context>
+      - name: Install mdBook
+        run: |
+          curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
+          rustup update
+          cargo install --version ${MDBOOK_VERSION} mdbook
+      - name: Setup Pages
</code_context>
<issue_to_address>
**suggestion (performance):** Running `rustup update` immediately after a fresh install is redundant and slows the workflow.

After installing via the bootstrap script, the toolchain is already up to date, so running `rustup update` each time only adds network and build time. Consider removing it or switching to a more targeted install that fetches only the required toolchain.

```suggestion
      - name: Install mdBook
        run: |
          curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
          cargo install --version ${MDBOOK_VERSION} mdbook
```
</issue_to_address>

Fix all in Cursor

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

sourcery-ai · 2026-04-19T21:46:02Z

+      - name: Install mdBook
+        run: |
+          curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
+          rustup update
+          cargo install --version ${MDBOOK_VERSION} mdbook


suggestion (performance): Running rustup update immediately after a fresh install is redundant and slows the workflow.

After installing via the bootstrap script, the toolchain is already up to date, so running rustup update each time only adds network and build time. Consider removing it or switching to a more targeted install that fetches only the required toolchain.

Suggested change

- name: Install mdBook

run: |

curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh

rustup update

cargo install --version ${MDBOOK_VERSION} mdbook

- name: Install mdBook

run: |

curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh

cargo install --version ${MDBOOK_VERSION} mdbook

Fix in Cursor

github-actions · 2026-04-19T22:47:07Z

Your PR title doesn't follow the Conventional Commit guidelines.

Example of valid titles:

feat: add new user login
fix: correct button size
docs: update README

Usage:

feat: Introduces a new feature
fix: Patches a bug
chore: General maintenance tasks or updates
test: Adding new tests or modifying existing tests
bench: Adding new benchmarks or modifying existing benchmarks
perf: Performance improvements
refactor: Changes to improve code structure
docs: Documentation updates
ci: Changes to CI/CD configurations
revert: Reverts a previously merged PR
deps: Updates dependencies

Breaking Changes

Breaking changes are noted by using an exclamation mark. For example:

feat!: changed the API
chore(node)!: Removed unused public function

Help

For more information, follow the guidelines here: https://www.conventionalcommits.org/en/v1.0.0/

Dargon789 and others added 15 commits March 4, 2026 01:53

Merge branch 'paradigmxyz:main' into main

2b32074

Create mdbook.yml

8587612

Signed-off-by: Dargon789 <64915515+Dargon789@users.noreply.github.com>

Dargon789 mentioned this pull request Apr 19, 2026

Flow diagram for mdBook GitHub Actions workflow jobs and steps #29

Closed

sourcery-ai Bot reviewed Apr 19, 2026

View reviewed changes

Dargon789 linked an issue Apr 19, 2026 that may be closed by this pull request

Flow diagram for mdBook GitHub Actions workflow jobs and steps #29

Closed

Dargon789 force-pushed the main branch from 3c7c6c7 to 79c9402 Compare July 22, 2026 12:48

Navigation Menu

Create mdbook.yml - #28

Create mdbook.yml#28
Dargon789 wants to merge 15 commits into
mainfrom
Dargon789-patch-1

Dargon789 commented Apr 19, 2026 •

edited by sourcery-ai Bot

Loading

Uh oh!

gemini-code-assist Bot commented Apr 19, 2026

Uh oh!

sourcery-ai Bot commented Apr 19, 2026 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai Bot left a comment

Uh oh!

sourcery-ai Bot Apr 19, 2026

Uh oh!

github-actions Bot commented Apr 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

Dargon789 commented Apr 19, 2026 • edited by sourcery-ai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by Sourcery

Uh oh!

gemini-code-assist Bot commented Apr 19, 2026

Uh oh!

sourcery-ai Bot commented Apr 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

Flow diagram for mdBook GitHub Actions workflow jobs and steps

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

sourcery-ai Bot Apr 19, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Apr 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Dargon789 commented Apr 19, 2026 •

edited by sourcery-ai Bot

Loading

sourcery-ai Bot commented Apr 19, 2026 •

edited

Loading