Update CI workflow with formatting and coverage#7
Merged
Conversation
Reviewer's GuideIntroduce an integrated GitHub Actions CI pipeline that runs formatting, linting, testing, and coverage upload to CodeScene, replacing the old standalone coverage workflow and updating documentation accordingly. Class diagram for CI workflow stepsclassDiagram
class CI_Workflow {
+Format
+Lint
+Test
+Coverage
+UploadCoverage
}
CI_Workflow : Format() runs make check-fmt
CI_Workflow : Lint() runs make lint
CI_Workflow : Test() runs make test
CI_Workflow : Coverage() runs cargo tarpaulin
CI_Workflow : UploadCoverage() uploads to CodeScene
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
## Walkthrough
The continuous integration (CI) setup for the project was consolidated and updated. The previous dedicated coverage workflow using Codecov was removed and replaced with a new, broader CI workflow that performs formatting, linting, testing, and uploads coverage metrics to CodeScene. Documentation in the README was updated to reflect these changes.
## Changes
| File(s) | Change Summary |
|-------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| README.md | Updated documentation to describe the new CI workflow and coverage upload to CodeScene. |
| template/.github/workflows/ci.yml | Added a new CI workflow: runs formatting, linting, tests, collects coverage, and uploads to CodeScene. |
| template/.github/workflows/coverage.yml | Removed the old coverage workflow that uploaded reports to Codecov. |
## Sequence Diagram(s)
```mermaid
sequenceDiagram
participant Developer
participant GitHub Actions
participant Rust Toolchain
participant CodeScene
Developer->>GitHub Actions: Open PR to main
GitHub Actions->>Rust Toolchain: Setup toolchain
GitHub Actions->>GitHub Actions: Run formatting (make check-fmt)
GitHub Actions->>GitHub Actions: Run linting (make lint)
GitHub Actions->>GitHub Actions: Run tests (make test)
GitHub Actions->>GitHub Actions: Install cargo-tarpaulin
GitHub Actions->>GitHub Actions: Collect coverage (lcov)
alt If CodeScene token available
GitHub Actions->>CodeScene: Upload coverage data
endPossibly related PRs
Poem
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
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> `template/.github/workflows/ci.yml:29` </location>
<code_context>
+ run: cargo install cargo-tarpaulin
+ - name: Run coverage
+ run: cargo tarpaulin --out lcov
+ - name: Upload coverage data to CodeScene
+ if: secrets.CS_ACCESS_TOKEN
+ uses: leynos/shared-actions/.github/actions/upload-codescene-coverage@v1.1.0
+ with:
+ format: lcov
+ access-token: ${{ secrets.CS_ACCESS_TOKEN }}
</code_context>
<issue_to_address>
The 'if: secrets.CS_ACCESS_TOKEN' condition may not work as intended.
Use 'if: ${{ secrets.CS_ACCESS_TOKEN }}' to ensure the condition is evaluated correctly and the step runs only when the secret is present.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🔭 Outside diff range comments (1)
template/.github/workflows/ci.yml (1)
36-37: Remove trailing blank line
YAMLlint flagged an extra blank line at the end of the file. Removing it will satisfy theempty-linesrule.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (3)
README.md(1 hunks)template/.github/workflows/ci.yml(1 hunks)template/.github/workflows/coverage.yml(0 hunks)
💤 Files with no reviewable changes (1)
- template/.github/workflows/coverage.yml
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~20-~20: The serial comma (Oxford comma, Harvard comma) is missing.
Context: ...tHub CI workflow** that formats, lints, tests and uploads coverage metrics to CodeScene...
(SERIAL_COMMA_ON)
🪛 YAMLlint (1.37.1)
template/.github/workflows/ci.yml
[warning] 3-3: truthy value should be one of [false, true]
(truthy)
[error] 36-36: too many blank lines
(1 > 0) (empty-lines)
🔇 Additional comments (2)
template/.github/workflows/ci.yml (1)
30-36: Verify the CodeScene access token conditional
Theif: secrets.CS_ACCESS_TOKENguard skips the upload when the secret is undefined. Please ensure thatCS_ACCESS_TOKENis set in repository secrets and confirm thatvars.CODESCENE_CLI_SHA256is defined in your repo variables.README.md (1)
24-25: Verify Codecov settings bullet
The template still mentions Codecov settings even though coverage is now uploaded to CodeScene. Confirm whether the Codecov configuration should be removed or updated to avoid confusion.
Owner
Author
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
Owner
Author
|
@sourcery-ai review |
There was a problem hiding this comment.
Hey @leynos - I've reviewed your changes - here's some feedback:
- Consider adding a caching step (using actions/cache) for Cargo registry and build artifacts to significantly speed up repeated CI runs.
- Pin the tarpaulin version when installing (e.g. cargo install cargo-tarpaulin --version X.Y.Z) or leverage an official setup action to prevent unexpected updates from breaking the build.
- You could simplify the workflow by using the actions-rs suite (e.g. actions-rs/toolchain and actions-rs/cargo-tarpaulin) instead of manual cargo install steps.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider adding a caching step (using actions/cache) for Cargo registry and build artifacts to significantly speed up repeated CI runs.
- Pin the tarpaulin version when installing (e.g. cargo install cargo-tarpaulin --version X.Y.Z) or leverage an official setup action to prevent unexpected updates from breaking the build.
- You could simplify the workflow by using the actions-rs suite (e.g. actions-rs/toolchain and actions-rs/cargo-tarpaulin) instead of manual cargo install steps.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
This was referenced Jun 23, 2025
This was referenced Aug 13, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Testing
pip install -r requirements.txtpytest -qmarkdownlint README.mdhttps://chatgpt.com/codex/tasks/task_e_685833604f38832294c9ab9390c619cd
Summary by Sourcery
Update the project’s CI pipeline to replace the standalone coverage workflow with a unified CI workflow that runs formatting, linting, testing, and uploads coverage metrics to CodeScene, and update the README to reference the new workflow.
CI:
Documentation:
Summary by CodeRabbit
Documentation
Chores