-
Notifications
You must be signed in to change notification settings - Fork 3.8k
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
chore: Add version input for generate info json script #38025
Conversation
WalkthroughThe changes in this pull request enhance the workflow configuration for the Ad-hoc Docker Image by adding three input parameters: Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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
|
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.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
scripts/generate_info_json.sh (2)
11-19
: LGTM! Consider enhancing the error message.The version validation logic is solid. The regex pattern correctly validates semantic versions, and the error handling is appropriate.
Consider enhancing the error message to include an example:
- echo "Invalid version format. Use v[major].[minor] or v[major].[minor].[patch]." >&2 + echo "Invalid version format. Use v[major].[minor] or v[major].[minor].[patch] (e.g., v1.2 or v1.2.3)." >&2
43-46
: Enhance usage documentation.Consider adding more comprehensive examples including:
- An example of an invalid version format
- A comment explaining the default behavior when no version is provided
# Usage # ./scripts/generate_info_json.sh v0.0.1 # ./scripts/generate_info_json.sh v0.1 -# ./scripts/generate_info_json.sh +# ./scripts/generate_info_json.sh # Uses latest git tag or generates SNAPSHOT version +# ./scripts/generate_info_json.sh v1 # Invalid format - will fail
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (2)
.github/workflows/ad-hoc-docker-image.yml
(1 hunks)scripts/generate_info_json.sh
(2 hunks)
🔇 Additional comments (1)
.github/workflows/ad-hoc-docker-image.yml (1)
Line range hint 1-24
: LGTM! Well-structured workflow configuration.
The workflow is well-organized with proper job dependencies and clear input parameters.
Description
PR to add version field in generate info json script. This will be used to override the version coming from the GH so that hotfixed tags should refelect the correct version instead of some random commit sha.
Fixes #
Issue Number
or
Fixes
Issue URL
Warning
If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.
Automation
/ok-to-test tags=""
🔍 Cypress test results
Caution
If you modify the content in this section, you are likely to disrupt the CI result for your PR.
Communication
Should the DevRel and Marketing teams inform users about this change?