Skip to content

Update to coverage #1285

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

Merged
merged 1 commit into from
Apr 3, 2025
Merged

Update to coverage #1285

merged 1 commit into from
Apr 3, 2025

Conversation

parmesant
Copy link
Contributor

@parmesant parmesant commented Apr 3, 2025

Github action fails because the runner's minimum supported version for CMAKE is 3.5 whereas the minimum version mentioned in librdkafka is 3.2 This PR introduces a (hopefully temporary) change which fetches the crates and modifies the CMakeLists.txt of librdkafka before installation

Fixes #XXXX.

Description


This PR has:

  • been tested to ensure log ingestion and log query works.
  • added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
  • added documentation for new or modified features or behaviors.

Summary by CodeRabbit

  • Chores
    • Enhanced the CI workflow with an automated step that updates dependency configuration settings to meet current requirements. The new process identifies configuration mismatches earlier through improved error reporting, leading to a more robust and reliable build process. This update helps ensure a smoother and more efficient development workflow by catching potential issues sooner.

Github action fails because the runner's minimum supported version for CMAKE is 3.5 whereas the minimum version mentioned in `librdkafka` is 3.2
This PR introduces a (hopefully temporary) change which fetches the crates and modifies the `CMakeLists.txt` of `librdkafka` before installation
Copy link
Contributor

coderabbitai bot commented Apr 3, 2025

Walkthrough

The change introduces a new job step in the GitHub Actions workflow defined in .github/workflows/coverage.yaml. This step modifies the CMakeLists.txt file for the librdkafka library. The script fetches a Rust package using cargo fetch, locates the rdkafka-sys package directory, creates a backup of CMakeLists.txt if found, and updates the minimum required CMake version from 3.2 to 3.5 using sed. If the file is not found, the script prints an error and exits with status 1.

Changes

File(s) Change Summary
.github/workflows/coverage.yaml Added a new job step that fetches a Rust package, locates the rdkafka-sys directory, backs up and updates the CMakeLists.txt file to increase the minimum CMake version from 3.2 to 3.5

Sequence Diagram(s)

sequenceDiagram
  participant GitHub as GitHub Actions
  participant Shell as Shell Script
  participant FS as Filesystem

  GitHub->>Shell: Execute new job step
  Shell->>FS: Run `cargo fetch`
  Shell->>FS: Locate `rdkafka-sys` package directory
  alt File found
    Shell->>FS: Create backup of `CMakeLists.txt`
    Shell->>FS: Update CMake version from 3.2 to 3.5 using sed
    Shell->>GitHub: Output diff of file changes
  else File not found
    Shell->>GitHub: Print error and exit (status 1)
  end
Loading

Poem

I'm a rabbit on a code trail, swift and bright,
Hopping through workflows in the moonlit night.
Tweaking CMake with a gentle command,
Leaving backups safely, just as planned.
I nibble on bugs, making problems slight!
🐰💻
Code and carrots, all feel 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

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 (7)
.github/workflows/coverage.yaml (7)

36-36: Nitpick: Remove trailing whitespace

Trailing whitespace is present on this blank line. Removing extra spaces helps maintain clean YAML formatting and prevents linting errors.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 36-36: trailing spaces

(trailing-spaces)


41-41: Nitpick: Remove trailing whitespace

Extra spaces detected at the end of this line. Please remove them to conform with YAML lint standards.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 41-41: trailing spaces

(trailing-spaces)


45-45: Nitpick: Remove trailing whitespace

Trailing spaces found on this line. Removing these unnecessary whitespaces will improve file consistency.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 45-45: trailing spaces

(trailing-spaces)


48-48: Nitpick: Remove trailing whitespace

This line contains trailing whitespace. Consider trimming the extra spaces for better formatting.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 48-48: trailing spaces

(trailing-spaces)


51-51: Nitpick: Remove trailing whitespace

Trailing whitespace detected here. Cleaning up these spaces helps avoid YAML lint errors.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 51-51: trailing spaces

(trailing-spaces)


54-54: Nitpick: Remove trailing whitespace

Extra whitespace is present at the end of this line. Please remove it to adhere to formatting guidelines.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 54-54: trailing spaces

(trailing-spaces)


57-57: Nitpick: Remove trailing whitespace

Trailing spaces found on this line. Removing them will help maintain a clean codebase.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 57-57: trailing spaces

(trailing-spaces)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 40876cd and 9a21870.

📒 Files selected for processing (1)
  • .github/workflows/coverage.yaml (1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.35.1)
.github/workflows/coverage.yaml

[error] 36-36: trailing spaces

(trailing-spaces)


[error] 41-41: trailing spaces

(trailing-spaces)


[error] 45-45: trailing spaces

(trailing-spaces)


[error] 48-48: trailing spaces

(trailing-spaces)


[error] 51-51: trailing spaces

(trailing-spaces)


[error] 54-54: trailing spaces

(trailing-spaces)


[error] 57-57: trailing spaces

(trailing-spaces)

⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: coverage
  • GitHub Check: Build Default aarch64-unknown-linux-gnu
  • GitHub Check: Build Default x86_64-unknown-linux-gnu
  • GitHub Check: Build Default x86_64-apple-darwin
  • GitHub Check: Build Default x86_64-pc-windows-msvc
  • GitHub Check: Build Default aarch64-apple-darwin
  • GitHub Check: Build Kafka aarch64-apple-darwin
  • GitHub Check: Build Kafka x86_64-unknown-linux-gnu
  • GitHub Check: Quest Smoke and Load Tests for Standalone deployments
  • GitHub Check: Quest Smoke and Load Tests for Distributed deployments
🔇 Additional comments (1)
.github/workflows/coverage.yaml (1)

37-63: Temporary Fix for librdkafka CMakeLists.txt

The new job step efficiently handles compatibility issues by:

  • Fetching the necessary Rust package using cargo fetch.
  • Locating the rdkafka-sys package directory.
  • Backing up the original CMakeLists.txt.
  • Using sed to update the minimum required CMake version from 3.2 to 3.5.

This workaround is a solid temporary solution to the CMake version mismatch issue encountered during GitHub Actions runs. It would be helpful to add an inline comment or documentation note explaining that this is a temporary patch until the upstream librdkafka is updated.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 41-41: trailing spaces

(trailing-spaces)


[error] 45-45: trailing spaces

(trailing-spaces)


[error] 48-48: trailing spaces

(trailing-spaces)


[error] 51-51: trailing spaces

(trailing-spaces)


[error] 54-54: trailing spaces

(trailing-spaces)


[error] 57-57: trailing spaces

(trailing-spaces)

@nitisht nitisht merged commit d00ac8c into parseablehq:main Apr 3, 2025
14 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Apr 25, 2025
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.

2 participants