Skip to content

Switch coverage upload to CodeScene#12

Merged
leynos merged 5 commits intomainfrom
codex/replace-codecov-upload-with-codescene
Jun 14, 2025
Merged

Switch coverage upload to CodeScene#12
leynos merged 5 commits intomainfrom
codex/replace-codecov-upload-with-codescene

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 13, 2025

Summary

  • use CodeScene's CLI for uploading coverage
  • adjust tarpaulin output to LCOV
  • remove standalone coverage workflow and set CS_ACCESS_TOKEN at the job level

Testing

  • cargo fmt --all -- --check
  • cargo clippy --all-targets --all-features -- -D warnings
  • cargo test
  • npx -y markdownlint-cli2 '**/*.md' '#node_modules' (fails: lint errors)
  • npx -y nixie '**/*.md' (fails: command error)

https://chatgpt.com/codex/tasks/task_e_684cadd5f0748322bd0de04bdb4e2213

Summary by Sourcery

Switch coverage reporting to CodeScene by integrating its CLI into the CI pipeline, adjusting tarpaulin to generate LCOV output, and removing the standalone coverage workflow.

CI:

  • Set CS_ACCESS_TOKEN env var at the job level and remove the separate coverage workflow
  • Switch cargo-tarpaulin output format from XML to LCOV
  • Install CodeScene CLI in CI and upload coverage with cs-coverage replacing Codecov

Summary by CodeRabbit

  • Chores
    • Updated continuous integration workflow to upload code coverage data to CodeScene instead of Codecov.
    • Removed the separate coverage workflow file.
    • Coverage data is now uploaded in LCOV format, with improved handling of access tokens for secure uploads.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 13, 2025

Reviewer's Guide

This PR updates the CI workflows to switch coverage reporting from Codecov to CodeScene by changing tarpaulin output, integrating the CodeScene CLI for upload, and removing the separate coverage workflow.

Sequence Diagram: Coverage Upload to CodeScene

sequenceDiagram
    participant Job as Test Job (GitHub Actions)
    participant Tarpaulin as cargo tarpaulin
    participant CS_CLI as CodeScene CLI
    participant CS_Service as CodeScene Service

    Job->>Tarpaulin: Execute: cargo tarpaulin --out Lcov
    Tarpaulin-->>Job: Returns lcov.info file
    alt CS_ACCESS_TOKEN is present
        Job->>CS_CLI: Install CodeScene CLI
        Job->>CS_CLI: Execute: cs-coverage upload lcov.info
        activate CS_CLI
        CS_CLI->>CS_Service: Upload coverage data (lcov.info)
        activate CS_Service
        CS_Service-->>CS_CLI: Acknowledge upload
        deactivate CS_Service
        CS_CLI-->>Job: Report upload status
        deactivate CS_CLI
    end
Loading

File-Level Changes

Change Details Files
Integrate CodeScene CLI for coverage upload in the CI workflow
  • Added CS_ACCESS_TOKEN to job environment
  • Changed tarpaulin output from XML to LCOV
  • Installed CodeScene coverage tool via install script with SHA256 verification
  • Replaced codecov-action with cs-coverage upload command using LCOV format
.github/workflows/ci.yml
Remove standalone coverage workflow
  • Deleted the dedicated coverage.yml workflow file
.github/workflows/coverage.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 13, 2025

Warning

Rate limit exceeded

@leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 12 minutes and 42 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 9733b59 and 6e763f3.

📒 Files selected for processing (2)
  • .github/workflows/ci.yml (1 hunks)
  • .github/workflows/get-codescene-sha.yml (1 hunks)

Walkthrough

The continuous integration (CI) workflow was updated to replace Codecov-based code coverage reporting with CodeScene integration. The workflow now generates coverage data in LCOV format and uploads it to CodeScene using a CLI tool, conditional on the presence of an access token. The previous standalone coverage workflow was deleted.

Changes

File(s) Change Summary
.github/workflows/ci.yml Updated to generate LCOV coverage, install and run CodeScene CLI for coverage upload, removed Codecov integration and system dependency installation.
.github/workflows/coverage.yml Deleted the workflow that previously handled coverage analysis and upload to Codecov.

Poem

In the warren of CI, a new path we pave,
From Codecov’s burrow, to CodeScene we wave.
LCOV in our paws, a token in tow,
We hop through the pipeline, coverage to show.
With scripts and with secrets, our journey is keen—
Hooray for the carrots of CodeScene! 🥕


🪧 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.

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey @leynos - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Copy Markdown
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: 3

🧹 Nitpick comments (1)
.github/workflows/ci.yml (1)

37-40: Avoid redundant redeclaration of the secret.

Since you’ll be moving CS_ACCESS_TOKEN into the scoped steps per the earlier suggestion, you can drop the env: block here. Also, consider using if: ${{ secrets.CS_ACCESS_TOKEN }} directly in the if condition to simplify the logic:

- if: env.CS_ACCESS_TOKEN != ''
+ if: secrets.CS_ACCESS_TOKEN
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2c367ec and b6ab6bd.

📒 Files selected for processing (2)
  • .github/workflows/ci.yml (2 hunks)
  • .github/workflows/coverage.yml (0 hunks)
💤 Files with no reviewable changes (1)
  • .github/workflows/coverage.yml
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build-test

Comment thread .github/workflows/ci.yml Outdated
Comment thread .github/workflows/ci.yml
Comment thread .github/workflows/ci.yml Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant