Add Code Coverage GH action

[Alirexaa]

Pull Request

Related issue

Fixes #507

What does this PR do?

This pull request introduces a new GitHub Actions workflow for measuring and reporting code coverage. The workflow is configured to run on specific branches and includes steps to set up the environment, install necessary tools, and upload coverage reports to Codecov.

Key changes:

• Added a new GitHub Actions workflow named coverage.yml to measure code coverage on trying, staging, and main branches.
• Configured permissions to allow reading contents and writing issues.
• Set up the environment to use Nightly Rust and installed cargo-llvm-cov for coverage data collection.
• Added steps to run Meilisearch using Docker, collect coverage data, and upload the reports to Codecov.

PR checklist

Please check if your PR fulfills the following requirements:

• [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
• [x] Have you read the contributing guidelines?
• [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

Summary by CodeRabbit

• Chores
  • Introduced automated code coverage reporting for pull requests and key branches.
  • Code coverage reports are now uploaded to Codecov, with CI configured to fail if the upload fails.

[Alirexaa]

@brunoocasali, I ran this action in my fork. You can see coverage results at https://app.codecov.io/github/Alirexaa/meilisearch-rust/pull/1/tree.

Make sure CODECOV_TOKEN has been set in repo secrets.

[coderabbitai[bot]]

Walkthrough

A new GitHub Actions workflow file, coverage.yml, has been added to automate code coverage reporting using Codecov. The workflow is triggered on pull requests and pushes to specific branches, runs Rust coverage tools, generates combined coverage reports, and uploads the results to Codecov, with conditional logic to skip certain branches and bots.

Changes

Files/Paths	Change Summary
.github/workflows/coverage.yml	Added a GitHub Actions workflow to automate Rust code coverage collection and upload to Codecov.

Assessment against linked issues

Objective	Addressed	Explanation
Add CodeCov to this repository. (#507)	✅
Add the CodeCov badge on this repository README.md (#507)	❌	No changes to README.md or badge addition observed.
Ensure a minimum coverage is accepted (optional) (#507)	❓	No explicit minimum coverage threshold configuration found in the workflow file.

Poem

Hopping through the coverage fields,
With Codecov now, our progress yields!
Rusty tests all run with flair,
Reports uploaded with bunny care.
Workflows dance, the carrots cheer—
Our code is covered, never fear!
🐰✨

[!NOTE]

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Learn more here.

---

[!NOTE]

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings. Enjoy the performance boost—your workflow just got faster.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.

[Mubelotix]

Thank you for your contribution! Coverage will be available on main shortly