Skip to content

Fix: versions_map, use awk instead of grep - #780

Merged
Andrei Kvapil (kvaps) merged 1 commit into
mainfrom
fix-versions-map
Apr 10, 2025
Merged

Fix: versions_map, use awk instead of grep#780
Andrei Kvapil (kvaps) merged 1 commit into
mainfrom
fix-versions-map

Conversation

@kvaps

@kvaps Andrei Kvapil (kvaps) commented Apr 9, 2025

Copy link
Copy Markdown
Member

Signed-off-by: Andrei Kvapil kvapss@gmail.com

Summary by CodeRabbit

  • Chores
    • Enhanced the internal version verification process to ensure improved precision and reliability in version validation.

@coderabbitai

coderabbitai Bot commented Apr 9, 2025

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

Andrei Kvapil (@kvaps) has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 24 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between d2f66a7 and 559eb8d.

📒 Files selected for processing (1)
  • hack/gen_versions_map.sh (2 hunks)

Walkthrough

The script hack/gen_versions_map.sh has been updated to replace grep with awk for extracting and comparing version strings from Chart.yaml files. The modifications adjust several checks including version validation for the current HEAD, commit files, and tag verification, ensuring a more precise and consistent matching process using a regular expression for version formats.

Changes

File(s) Change Summary
hack/gen_versions_map.sh Replaced grep with awk for filtering tags and extracting version values from Chart.yaml. Updated version checks for HEAD, commits, and tag validations.

Sequence Diagram(s)

sequenceDiagram
    participant S as gen_versions_map.sh
    participant C as Chart.yaml
    participant AW as awk
    S->>C: Read version string
    S->>AW: Execute awk with regex (vX.X.X)
    AW-->>S: Return extracted version
    S->>S: Compare version against expected value
Loading

Possibly related PRs

Suggested reviewers

  • lllamnyp
  • klinch0

Poem

In the quiet of code, I happily hop,
Skipping past bugs that once made me stop.
With "awk" as my friend, my path is bright,
Extracting versions in the soft twilight.
Celebrations abound – code stands right! 🐇✨


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (4)
hack/gen_versions_map.sh (4)

22-22: Enhancement: Refine version matching regex in tag search.
The updated use of awk to filter tags is a good move for precision. However, the regular expression /v[0-9]+.[0-9]+.[0-9]+/ matches any character in place of the literal dot. Consider escaping the dot characters (i.e. use /v[0-9]+\.[0-9]+\.[0-9]+/) to ensure that only properly formatted semantic version strings (e.g., v1.2.3) are matched.

-awk -F/ '$3 ~ /v[0-9]+.[0-9]+.[0-9]+/ {print}'
+awk -F/ '$3 ~ /v[0-9]+\.[0-9]+\.[0-9]+/ {print}'

29-29: Bug Risk: Unquoted command substitution may lead to word splitting.
The condition on line 29 uses command substitution without quotes, which can introduce issues if the file content contains spaces or unexpected characters. Quoting the substitution will safeguard against splitting problems.

-    if [ $(awk '$1 == "version:" {print $2}' ./${chart}/Chart.yaml) = "${version}" ]; then
+    if [ "$(awk '$1 == "version:" {print $2}' "./${chart}/Chart.yaml")" = "${version}" ]; then
🧰 Tools
🪛 Shellcheck (0.10.0)

[warning] 29-29: Quote this to prevent word splitting.

(SC2046)


36-36: Bug Risk: Unquoted command substitution in version check.
Line 36’s command substitution for extracting the version from the commit’s Chart.yaml should be quoted. This prevents potential word splitting issues when comparing against the expected version value.

-      if [ $(git show "${commit}:./${chart}/Chart.yaml" 2>/dev/null | awk '$1 == "version:" {print $2}') != "${version}" ]; then
+      if [ "$(git show "${commit}:./${chart}/Chart.yaml" 2>/dev/null | awk '$1 == "version:" {print $2}')" != "${version}" ]; then
🧰 Tools
🪛 Shellcheck (0.10.0)

[warning] 36-36: Quote this to prevent word splitting.

(SC2046)


49-49: Bug Risk: Protect command substitution output with quotes.
Similarly, on line 49, the command substitution output from git show should be quoted to ensure a reliable and safe comparison against the version string.

-      if [ $(git show "${tag}:./${chart}/Chart.yaml" 2>/dev/null | awk '$1 == "version:" {print $2}') = "${version}" ]; then
+      if [ "$(git show "${tag}:./${chart}/Chart.yaml" 2>/dev/null | awk '$1 == "version:" {print $2}')" = "${version}" ]; then
🧰 Tools
🪛 Shellcheck (0.10.0)

[warning] 49-49: Quote this to prevent word splitting.

(SC2046)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bdb538a and d2f66a7.

📒 Files selected for processing (1)
  • hack/gen_versions_map.sh (2 hunks)
🧰 Additional context used
🪛 Shellcheck (0.10.0)
hack/gen_versions_map.sh

[warning] 29-29: Quote this to prevent word splitting.

(SC2046)


[warning] 36-36: Quote this to prevent word splitting.

(SC2046)


[warning] 49-49: Quote this to prevent word splitting.

(SC2046)

Signed-off-by: Andrei Kvapil <kvapss@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant