Skip to content

Replace coverage workflow#43

Merged
leynos merged 6 commits intomainfrom
codex/replace-coverage-workflow-with-new-version
Jul 31, 2025
Merged

Replace coverage workflow#43
leynos merged 6 commits intomainfrom
codex/replace-coverage-workflow-with-new-version

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jul 30, 2025

Summary

  • replace the old coverage workflow with a CI workflow
  • share the commit SHA for shared-actions across job steps

Testing

  • make fmt
  • make lint
  • make test

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

Summary by Sourcery

Overhaul the GitHub Actions workflow into a unified CI job that runs Rust setup, formatting, linting, coverage generation, and conditional CodeScene upload using pinned shared actions.

Enhancements:

  • Rename the workflow from Coverage to CI and the job from coverage to build-test
  • Add a variables section to pin shared composite actions to a specific commit SHA
  • Replace manual Rust toolchain and coverage commands with shared-actions steps
  • Add Format and Lint steps using make targets
  • Introduce a conditional CodeScene coverage upload step that uses an access token

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jul 30, 2025

Reviewer's Guide

This PR replaces the standalone coverage workflow with a single CI workflow by consolidating build, format, lint, test, coverage generation, and CodeScene upload into one job, leveraging pinned shared-actions for reproducibility.

File-Level Changes

Change Details Files
Consolidate multiple CI tasks into one unified job
  • Renamed workflow from Coverage to CI and job from coverage to build-test
  • Added format and lint steps invoking Make targets
  • Replaced direct Rust setup and coverage commands with shared composite actions
.github/workflows/coverage.yml
Introduce version pinning and environment variables for shared-actions
  • Defined SHARED_ACTIONS_SHA variable to pin shared-actions commits
  • Added CS_ACCESS_TOKEN and CODESCENE_CLI_SHA256 to job environment
  • Updated action references to use shared-actions at specified SHA and version
.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

coderabbitai Bot commented Jul 30, 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 1 minutes and 16 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 4e56087 and c575636.

📒 Files selected for processing (1)
  • .github/workflows/coverage.yml (1 hunks)

Summary by CodeRabbit

  • Chores
    • Updated the continuous integration workflow with a new name and improved structure.
    • Introduced workflow variables for enhanced security and reliability.
    • Replaced external actions with internal shared actions for Rust setup, coverage generation, and coverage upload.
    • Added separate formatting and linting steps to the workflow.
    • Simplified and improved coverage upload configuration.

Walkthrough

Rename the GitHub Actions workflow from "Coverage" to "CI" and update the job name to "build-test". Introduce and propagate new environment variables. Replace direct Rust and coverage tool setup with shared actions, integrate formatting and linting steps, and switch coverage upload from Codecov to CodeScene via a shared action.

Changes

Cohort / File(s) Change Summary
CI Workflow Refactor
.github/workflows/coverage.yml
Rename workflow and job, add and propagate new environment variables, switch to shared Rust setup and coverage actions, add formatting/linting steps, and change coverage upload from Codecov to CodeScene.

Sequence Diagram(s)

sequenceDiagram
  participant GitHub_Actions
  participant Shared_Setup_Rust
  participant Shared_Generate_Coverage
  participant Shared_Upload_Codescene
  participant CodeScene

  GitHub_Actions->>Shared_Setup_Rust: Setup Rust toolchain (via shared action)
  GitHub_Actions->>GitHub_Actions: Run formatting (make check-fmt)
  GitHub_Actions->>GitHub_Actions: Run linting (make lint)
  GitHub_Actions->>GitHub_Actions: Run tests
  GitHub_Actions->>Shared_Generate_Coverage: Generate coverage report
  GitHub_Actions->>Shared_Upload_Codescene: Upload coverage (if CS_ACCESS_TOKEN)
  Shared_Upload_Codescene->>CodeScene: Send coverage data
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Poem

From Coverage to CI, the workflow takes flight,
With shared actions guiding each build through the night.
Formatting and linting, all neat in a row,
Coverage to CodeScene, the reports swiftly go.
In pipelines united, the code’s future is bright!
🚀✨

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/replace-coverage-workflow-with-new-version

🪧 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 generate unit tests to generate unit tests for 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

@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: 4

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 88b07f2 and 9c9bc42.

📒 Files selected for processing (1)
  • .github/workflows/coverage.yml (1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.7)
.github/workflows/coverage.yml

19-19: context "env" is not allowed here. no context is available here. see https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability for more details

(expression)


25-25: context "env" is not allowed here. no context is available here. see https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability for more details

(expression)

Comment thread .github/workflows/coverage.yml Outdated
Comment thread .github/workflows/coverage.yml
Comment thread .github/workflows/coverage.yml Outdated
Comment thread .github/workflows/coverage.yml Outdated
@leynos
Copy link
Copy Markdown
Owner Author

leynos commented Jul 31, 2025

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jul 31, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@leynos
Copy link
Copy Markdown
Owner Author

leynos commented Jul 31, 2025

@sourcery-ai review

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!

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `.github/workflows/coverage.yml:7` </location>
<code_context>
   pull_request:
     branches: [main]

+variables:
+  # This SHA pins shared composite actions to a specific commit for
+  # reproducibility. Update it manually when bumping shared-actions to
+  # guarantee consistent workflow behaviour.
+  SHARED_ACTIONS_SHA: e48ed26d7f53f12f56eb7bcfdfdfe4d97065ea4c
+
 jobs:
</code_context>

<issue_to_address>
Consider using 'env' instead of 'variables' for workflow-wide variables.

'variables:' is not supported at the workflow level in GitHub Actions; use 'env:' to define variables accessible throughout the workflow.
</issue_to_address>

### Comment 2
<location> `.github/workflows/coverage.yml:23` </location>
<code_context>
-      - uses: taiki-e/install-action@cargo-llvm-cov@v2
-
+      - name: Setup Rust
+        uses: leynos/shared-actions/.github/actions/setup-rust@${{ vars.SHARED_ACTIONS_SHA }}
+      - name: Format
+        run: make check-fmt
</code_context>

<issue_to_address>
Using a variable in the action reference may not be supported.

GitHub Actions does not support expressions like '${{ vars.SHARED_ACTIONS_SHA }}' in the 'uses' field, which may cause the workflow to fail. Please hardcode the SHA or use a matrix/strategy for dynamic values.
</issue_to_address>

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.

Comment thread .github/workflows/coverage.yml Outdated
Comment thread .github/workflows/coverage.yml Outdated
Copy link
Copy Markdown

@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: 2

♻️ Duplicate comments (1)
.github/workflows/coverage.yml (1)

28-33: Upload lcov.info as artefact so coverage is never lost

Previous review already requested persisting the coverage file when the CodeScene upload is skipped. The extra step is still missing.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9c9bc42 and 4e56087.

📒 Files selected for processing (1)
  • .github/workflows/coverage.yml (1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.7)
.github/workflows/coverage.yml

7-7: unexpected key "variables" for "workflow" section. expected one of "concurrency", "defaults", "env", "jobs", "name", "on", "permissions", "run-name"

(syntax-check)


23-23: context "vars" is not allowed here. no context is available here. see https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability for more details

(expression)


29-29: context "vars" is not allowed here. no context is available here. see https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability for more details

(expression)

Comment thread .github/workflows/coverage.yml Outdated
Comment thread .github/workflows/coverage.yml Outdated
Sadly, `uses` does not support interpolation
@leynos leynos merged commit 5500cc3 into main Jul 31, 2025
2 checks passed
@coderabbitai coderabbitai Bot mentioned this pull request Aug 1, 2025
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