Conversation
WalkthroughThis pull request updates the Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant EM as EVM-Middleware
participant RK as Rollkit
Dev->>EM: Run "evm-middleware" with JWT secret
EM-->>Dev: Middleware started
Dev->>Dev: Checkout branch `feature/exec_api`
Dev->>RK: Build and start Rollkit
RK-->>Dev: Rollkit running
Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
RollkitBot
requested review from
Manav-Aggarwal,
tuxcanfly and
yarikbratashchuk
and removed request for
a team
tzdybal
force-pushed
the
tzdybal/readme_deploy
branch
from
37020bf to
365d926
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
README.md (3)
78-83: Enhance Markdown Fence Formatting forevm-middlewareInstructionsThe new instructions for running the
evm-middlewarebinary are clear and add value to the deployment documentation. However, to satisfy markdown lint guidelines (MD031), please ensure that fenced code blocks are surrounded by blank lines. For example, insert a blank line before and after the ```bash code fence.-78~ -Run `evm-middleware` binary: -79~ -```bash -./build/evm-middleware run --jwt-secret $(cat docker/jwttoken/jwt.hex) -``` -82~ +78~ +Run `evm-middleware` binary: +79~ + +```bash +./build/evm-middleware run --jwt-secret $(cat docker/jwttoken/jwt.hex) +``` +82~🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
80-80: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
🪛 GitHub Actions: CI and Release
[warning] 80-80: MD031/blanks-around-fences: Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
84-90: Improve Markdown Fence Spacing for Rollkit Deployment InstructionsThe additional instructions for compiling and running rollkit from the
feature/exec_apibranch are well detailed. To adhere to markdown guidelines (MD031), please add blank lines before and after the fenced code block. This enhancement improves readability and reduces markdown lint warnings.-84~ -Compile rollkit from `feature/exec_api` branch and run it: -85~ -```bash -git checkout feature/exec_api -go build ./cmd/rollkit -./rollkit start -``` -90~ +84~ +Compile rollkit from `feature/exec_api` branch and run it: +85~ + +```bash +git checkout feature/exec_api +go build ./cmd/rollkit +./rollkit start +``` +90~🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
85-85: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
🪛 GitHub Actions: CI and Release
[warning] 85-85: MD031/blanks-around-fences: Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
91-91: Eliminate Excessive Blank LinesThere appear to be multiple consecutive blank lines at the end of the file (MD012). Please reduce them to a single blank line to comply with markdown best practices.
-91 - - +91 +🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
91-91: Multiple consecutive blank lines
Expected: 1; Actual: 2(MD012, no-multiple-blanks)
🪛 GitHub Actions: CI and Release
[warning] 91-91: MD012/no-multiple-blanks: Multiple consecutive blank lines [Expected: 1; Actual: 2]
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
80-80: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
85-85: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
🪛 GitHub Actions: CI and Release
README.md
[warning] 80-80: MD031/blanks-around-fences: Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
[warning] 85-85: MD031/blanks-around-fences: Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
[warning] 91-91: MD012/no-multiple-blanks: Multiple consecutive blank lines [Expected: 1; Actual: 2]
2 participants
Overview
Steps to test deployment added to readme.
Summary by CodeRabbit