feat(stats): dependency table #1231
Conversation
WalkthroughThis pull request updates the workflow configuration and service documentation. Within the workflow file ( Poem
Tip 🌐 Web search-backed reviews and chat
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 (
|
![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)
stats/README.md (3)
14-15: Ensure Consistent Unordered List Styling.
Static analysis indicates that unordered list items should use plus signs instead of dashes (MD004). Consider updating these list markers from “-” to “+” for a consistent markdown style throughout the document.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
14-14: Unordered list style
Expected: plus; Actual: dash(MD004, ul-style)
15-15: Unordered list style
Expected: plus; Actual: dash(MD004, ul-style)
17-27: Correct Header Typo in Dependency Section.
The header currently reads “Dependecy version requirements.” Please correct the spelling to “Dependency version requirements.”Proposed diff:
-### Dependecy version requirements +### Dependency version requirements
227-227: Fix Typo in Blockscout Instance Instructions.
There’s a typographical error: “varialbe” should be corrected to “variable.”Proposed diff:
-+ Start blockscout instance with varialbe `DATABASE_URL=postgres://postgres:[email protected]:5432/blockscout` +Start blockscout instance with variable `DATABASE_URL=postgres://postgres:[email protected]:5432/blockscout`
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.github/workflows/stats.yml(1 hunks)stats/README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
stats/README.md
14-14: Unordered list style
Expected: plus; Actual: dash
(MD004, ul-style)
15-15: Unordered list style
Expected: plus; Actual: dash
(MD004, ul-style)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Unit, doc and integration tests
🔇 Additional comments (5)
.github/workflows/stats.yml (1)
69-72: Clarify Logging Removal in DB Tests Step.
The inline comments now provide a clear rationale for removing extensive logging during the DB tests (improving performance and log manageability). Ensure that, if needed, an alternative logging approach is considered for troubleshooting in non-performance-critical environments.stats/README.md (4)
7-8: Enhance Service Components Description.
The added lines clearly distinguish between the stats calculation library and the transport layer (stats-server). This additional detail improves the overall architectural clarity of the service.
32-34: Update Docker Build Instructions.
The newly added instructions for building via a Dockerfile and pulling images from the registry are clear and add valuable context. This helps streamline the build process for users.
219-220: Include Prerequisite Installation Details.
The checklist for installing Docker, Rust, and Just in the "For development" section is a useful addition to help developers set up their environment correctly.
242-245: Clarify Docker Compose Environment Settings.
The new instructions detailing the setting ofETHEREUM_JSONRPC_HTTP_URL,FIRST_BLOCK, andETHEREUM_JSONRPC_VARIANTfollowed by the Docker Compose command provide clear guidance for configuring the development environment.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
stats/README.md (2)
14-15: Consistent Markdown List Style Suggested
The newly added list items here use dashes; however, markdownlint (MD004) recommends using plus signs for unordered lists. Consider updating these lines to use plus signs for consistency with our style guidelines.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
14-14: Unordered list style
Expected: plus; Actual: dash(MD004, ul-style)
15-15: Unordered list style
Expected: plus; Actual: dash(MD004, ul-style)
17-27: Typo and Clarity in Dependency Version Requirements Section
There is a minor typo in the section header on line 17—"Dependecy" should be corrected to "Dependency." Other than that, the new table and accompanying description provide a valuable and clear summary of version requirements.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
stats/README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
stats/README.md
14-14: Unordered list style
Expected: plus; Actual: dash
(MD004, ul-style)
15-15: Unordered list style
Expected: plus; Actual: dash
(MD004, ul-style)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Unit, doc and integration tests
🔇 Additional comments (4)
stats/README.md (4)
7-8: Addition of New Service Components
The new bullet items clearly delineate the separation between the stats calculation library and the transport layer. Their use of the plus sign for list markers aligns with best practices.
32-35: Enhanced Build Instructions with Docker Information
The added build instructions clearly show users how to build the service using Docker, both via the provided Dockerfile and the registry images. Please ensure that the linked resources remain up-to-date as the repository evolves.
219-221: Clear Prerequisites for Development Environment
The additional instructions in the "For development" section—especially the installation links for Docker, Rust, and Just—are clear and helpful for new developers setting up the environment.
242-245: Improved Docker Compose Guidance for Development
The new steps for setting environment variables and running the docker compose file enhance the development documentation. This guidance should help reduce initial setup friction.
stats/README.md
Outdated
| @@ -11,6 +11,19 @@ The service consists of 2 parts, a stats calculation library and a transport lay | |||
|
|
|||
| - Postgresql database for this service | |||
| - Access to Blockscout database | |||
| - (Preferable) Access to Blockscout API | |||
There was a problem hiding this comment.
What does preferable mean and what happens if an access would not be available?
There was a problem hiding this comment.
I've added some lead to more info, can you recheck and see if it's clear now?
There was a problem hiding this comment.
It's better now, yes. Though I still believe 'preferable' is not the best name for such (sometimes required sometimes optional) requirements, but I cannot come up with anything better as well
There was a problem hiding this comment.
Maybe someone on the tech call will come up with a better approach 😇
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
stats/README.md (5)
7-8: Consistent List Markers for Service Components
The new bullet points use a plus sign, which doesn't match the dashed markers used in the Requirements section. Consider standardizing the list marker style across the document for clarity and consistency.
17-17: Typo in Section Heading
The heading "### Dependecy version requirements" contains a typo. Please change "Dependecy" to "Dependency".
19-21: Rephrase for Improved Clarity
The phrase "if there is a need in using older versions" could be reworded for better readability. Consider changing it to "if you need to use older versions".
38-38: Concise Docker Compose Instructions
The Docker Compose instructions are succinct and direct. You might consider adding a brief note on any required environment variables if applicable.
226-226: Typographical Error in Development Instructions
There is a typo in the phrase "Start blockscout instance with varialbe…". It should read "variable".
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
stats/README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
stats/README.md
14-14: Unordered list style
Expected: plus; Actual: dash
(MD004, ul-style)
15-15: Unordered list style
Expected: plus; Actual: dash
(MD004, ul-style)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Unit, doc and integration tests
🔇 Additional comments (4)
stats/README.md (4)
23-26: New Dependency Version Table Added
The added table clearly outlines the recommended versions for the Blockscout and User Ops Indexer components. The rows are sorted in descending order as previously suggested.
32-34: Clear Docker Build Instructions
The instructions detailing how to build the service using the Dockerfile and the registry link are clear and helpful.
288-288: Enhanced Development Setup Instructions
The new development setup instructions—complete with installation links for Docker, Rust, and Just—are a valuable addition for onboarding developers.
311-317: Comprehensive Docker Compose Guidance
The Docker Compose section provides clear, actionable steps that are easy to follow. Great job on enhancing the documentation!
Summary by CodeRabbit
Chores
Documentation