-
Notifications
You must be signed in to change notification settings - Fork 101
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.
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
Add print-block
cmd to scripts README
#1096
Conversation
WalkthroughThe update enhances the script execution command by incorporating environment variable settings for Changes
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
indexer/services/scripts/README.md
Outdated
KAFKA_BROKER_URLS=b-1.devindexerapne1ms.e0k85v.c3.kafka.ap-northeast-1.amazonaws.com:9092 \ | ||
SERVICE_NAME=scripts pnpm run print-block -- --h 9265388 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The addition of KAFKA_BROKER_URLS
and SERVICE_NAME
environment variables in the script execution command enhances the documentation by providing clear instructions on how to configure the script for different environments. This is a positive change that improves the usability and configurability of the scripts. However, it would be beneficial to include a brief explanation or description of these environment variables directly in the README for users unfamiliar with their purpose or how to obtain their values. Adding such descriptions can further improve the documentation's clarity and usefulness to new users or contributors.
indexer/services/scripts/README.md
Outdated
@@ -15,6 +15,10 @@ Example: | |||
pnpm run validate-pnl -- \ | |||
--s 964e4f37-1314-5181-bcf9-d3b0a30d86ed \ | |||
--p d6f67aac-749d-5f62-8a55-ef825915b575 d6f67aac-749d-5f62-8a55-ef825915b575 | |||
|
|||
|
|||
KAFKA_BROKER_URLS=b-1.devindexerapne1ms.e0k85v.c3.kafka.ap-northeast-1.amazonaws.com:9092 \ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: I don't think we want to expose our dev kafka url in README
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (1)
- indexer/services/scripts/README.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- indexer/services/scripts/README.md
Changelist
Add
print-block
cmd to scripts READMETest Plan
Author/Reviewer Checklist
state-breaking
label.indexer-postgres-breaking
label.PrepareProposal
orProcessProposal
, manually add the labelproposal-breaking
.feature:[feature-name]
.backport/[branch-name]
.refactor
,chore
,bug
.