fix: Add missing safedb.path op-node config option #960
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
WalkthroughThe pull request introduces a new configuration option for the Changes
Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🧰 Additional context used🔇 Additional comments (2)
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
Documentation and Community
|
![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
🧹 Outside diff range and nitpick comments (1)
pages/builders/node-operators/configuration/consensus-config.mdx (1)
726-734: LGTM with minor suggestions.The addition of the
safedb.pathconfiguration option is clear and well-documented. However, consider the following improvements:
- For consistency with other environment variables, consider changing
SAFEDB_PATHtoOP_NODE_SAFEDB_PATH.- Remove the extra newlines at the beginning and end of the section to maintain consistent formatting with other options.
Here's a suggested revision:
### safedb.path - File path used to persist safe head update data. Disabled if not set. - <Tabs items={['Syntax', 'Example', 'Environment Variable']}> <Tabs.Tab>`--safedb.path=<value>`</Tabs.Tab> <Tabs.Tab>`--safedb.path=/db`</Tabs.Tab> - <Tabs.Tab>`SAFEDB_PATH=/db`</Tabs.Tab> + <Tabs.Tab>`OP_NODE_SAFEDB_PATH=/db`</Tabs.Tab> </Tabs> -🧰 Tools
🪛 LanguageTool
[style] ~732-~732: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...> <Tabs.Tab>--safedb.path=/db</Tabs.Tab> <Tabs.Tab>SAFEDB_PATH=/db</Tabs.Ta...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
- pages/builders/node-operators/configuration/consensus-config.mdx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/node-operators/configuration/consensus-config.mdx (1)
Pattern
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Use bold for prominence instead of all caps or italics.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for headers, buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
"
🪛 LanguageTool
pages/builders/node-operators/configuration/consensus-config.mdx
[style] ~732-~732: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...> <Tabs.Tab>--safedb.path=/db</Tabs.Tab> <Tabs.Tab>SAFEDB_PATH=/db</Tabs.Ta...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Description
Adds a missing option to the
op-nodeconfig page:safedb.path: https://github.com/ethereum-optimism/optimism/blob/f33a0a9e65e40afb7d62dc264ed36f28a29d9360/op-node/flags/flags.go#L313-L318Tests
Manually tested.
Additional context
Metadata