Add Code Coverage GH action #654
Conversation
|
@brunoocasali, I ran this action in my fork. Make sure |
WalkthroughA new GitHub Actions workflow file, Changes
Assessment against linked issues
Poem
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit 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. Note ⚡️ Faster reviews with cachingCodeRabbit 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 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (4)
.github/workflows/coverage.yml (4)
3-11: Simplify triggers by filtering branches at theonlevel
You can move branch restrictions into theonblock to avoid complexiflogic and unnecessary job invocations:on: - pull_request: - push: - branches: - - trying - - staging - - main + pull_request: + branches: [trying, staging, main] + push: + branches: [trying, staging, main]This makes it clear which branches trigger the workflow and lets you remove some of the conditional complexity below.
28-33: Consider using the officialactions-rs/toolchainaction
Instead of the community forkdtolnay/rust-toolchain@nightly, the maintainedactions-rs/toolchain@v1is more widely used and regularly updated:- - uses: dtolnay/rust-toolchain@nightly - with: - components: llvm-tools-preview + - uses: actions-rs/toolchain@v1 + with: + profile: minimal + toolchain: nightly + override: true + components: llvm-tools-preview
39-45: Fail fast on coverage steps
Wrap the combined commands with a stricter shell mode to stop on any error and avoid proceeding with incomplete data:- - name: Collect coverage data - run: | + - name: Collect coverage data + run: | + set -euo pipefail cargo llvm-cov --no-report --all-features --workspace cargo llvm-cov --no-report --doc --all-features --workspace cargo llvm-cov report --doctests --codecov --output-path codecov.jsonThis will immediately break if any subcommand fails.
46-50: Pin the Codecov Action to a specific patch version
Using@v5can introduce unexpected changes when the action is updated. Pin to a known release, e.g.:- - name: Upload coverage reports to Codecov - uses: codecov/codecov-action@v5 + - name: Upload coverage reports to Codecov + uses: codecov/[email protected]This locks you to the tested version and avoids surprises on minor bumps.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
.github/workflows/coverage.yml(1 hunks)
🔇 Additional comments (1)
.github/workflows/coverage.yml (1)
12-15: Review required permissions
The Codecov Action may need additional permissions to post status checks or PR comments. Currently you have:permissions: contents: read issues: writeConsider narrowing and adding only what’s required, for example:
permissions: contents: read checks: write pull-requests: writePlease verify the minimum scopes the Codecov Action requires.
|
Thank you for your contribution! Coverage will be available on main shortly |
682: Merge dev into main r=curquiza a=Mubelotix Full changelog after this PR: (includes changes merged before this PR) ## What's Changed ### Breaking changes * Fix deleted_tasks field type in TaskDeletion struct by `@coinmoles` in #666 (`TaskDeletion.deleted_tasks` and `TaskCancelation.canceled_tasks` have been made `Option`s) ### Enhancements * Support all experimental features by `@ellnix` in #656 * Add `usedDatabaseSize` to stats by `@Alirexaa` in #653 * Add facet_search API functionality by `@hmacr` in #512 * Allow users to customize facet value sort behaviour by `@hmacr` in #514 * Support `embedders` setting and other vector/hybrid search related configuration by `@CommanderStorm` in #554 * Add documents and embbedings database metrics to stats response by `@Alirexaa` in #652 * Support facet search and prefix search settings by `@ellnix` in #634 * Serialize for MultiSearchResponse by `@milesgranger` in #668 * Implement federated multi search by `@LukasKalbertodt` in #625 * Add support for similar docs query by `@JiaYingZhang` in #674 ### Maintainance * Remove _md code samples for Mintlify migration by `@curquiza` in #661 * Add missing `exist` to `*_update` functions' docs by `@funlennysub` in #617 * Add Code Coverage GH action by `@Alirexaa` in #654 ## New Contributors * `@Alirexaa` made their first contribution in #653 * `@funlennysub` made their first contribution in #617 * `@milesgranger` made their first contribution in #668 * `@coinmoles` made their first contribution in #666 * `@JiaYingZhang` made their first contribution in #674 **Full Changelog**: v0.28.0...v0.29.0 Co-authored-by: hmacr <[email protected]> Co-authored-by: Clémentine U. - curqui <[email protected]> Co-authored-by: Frank Elsinga <[email protected]> Co-authored-by: Clémentine <[email protected]> Co-authored-by: Vladimir Donich <[email protected]>
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:
coverage.ymlto measure code coverage ontrying,staging, andmainbranches.cargo-llvm-covfor coverage data collection.PR checklist
Please check if your PR fulfills the following requirements:
Thank you so much for contributing to Meilisearch!
Summary by CodeRabbit