-
Notifications
You must be signed in to change notification settings - Fork 2
Tidy CI workflow #617
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Tidy CI workflow #617
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR consolidates the separate build/test and coverage workflows into a single matrix-based job, simplifying CI and reducing duplication.
- Merged
build_and_testandcoveragejobs into onebuild_and_testjob with an OS matrix - Removed the old
cargo-build-and-test.yml - Added a reusable composite action for code coverage
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| .github/workflows/cargo-test.yml | New unified workflow defining test matrix & coverage upload on Ubuntu |
| .github/workflows/cargo-build-and-test.yml | Deleted legacy workflow (redundant after merge) |
| .github/actions/codecov/action.yml | New composite action to install and run coverage tools |
Comments suppressed due to low confidence (3)
.github/workflows/cargo-test.yml:1
- [nitpick] Consider updating the workflow name to reflect both build, test, and coverage (e.g.,
CI / Build & Test & Coverage) so it’s clear in the UI what the job encompasses.
name: Cargo Test
.github/workflows/cargo-test.yml:27
- [nitpick] Pin the local composite action to a specific ref or tag if it becomes external in the future, to avoid unintentional changes when the action is updated.
- if: ${{ matrix.os == 'ubuntu-latest' }}
.github/workflows/cargo-test.yml:4
- Remember to update branch protection rules or any external documentation that reference the old
Cargo Build & Testworkflow name.
push:
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #617 +/- ##
=======================================
Coverage 85.34% 85.34%
=======================================
Files 38 38
Lines 3399 3399
Branches 3399 3399
=======================================
Hits 2901 2901
Misses 305 305
Partials 193 193 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
af1a903 to
08e97ec
Compare
Description
I've been fiddling with our CI workflow for running tests while working on #616 and realised it could be simplified a bit. Previously, the Ubuntu runner was also checking documentation and uploading test coverage in addition to running the actual tests, but now the only extra thing it's doing is uploading coverage, so it's simpler if we just have one "job" that covers all the runners.
I also made various other small tweaks, including changing the name of the workflow (so we'll need to update our branch protection rules).
Type of change
Key checklist
$ cargo test$ cargo docFurther checks