Fix ratchet step order in generate-coverage action#49
Conversation
Reviewer's GuideThis PR fixes the ordering of the ratchet coverage step in the generate-coverage action by moving it after Python coverage generation and adds a corresponding changelog entry. Flow diagram for updated generate-coverage action step orderflowchart TD
A[Start] --> B[Detect language]
B --> C[Cache Rust deps]
C --> D[Run Rust coverage]
D --> E[Cache Python deps]
E --> F[Run Python coverage]
F --> G[Combine coverage results]
G --> H[Ratchet coverage]
H --> I[Save baselines]
I --> J[Set outputs]
J --> K[End]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Summary by CodeRabbit
WalkthroughUpdate the GitHub Action workflow for coverage generation by moving the ratchet coverage and baseline saving steps to execute after both Rust and Python coverage results are available. Add a changelog entry documenting this adjustment in step ordering. No changes to logic or exported entities are introduced. Changes
Sequence Diagram(s)sequenceDiagram
participant Workflow
participant RustCoverage
participant PythonCoverage
participant MergeCoverage
participant RatchetCoverage
participant SaveBaselines
Workflow->>RustCoverage: Run Rust coverage
Workflow->>PythonCoverage: Run Python coverage
Workflow->>MergeCoverage: Merge coverage (if needed)
Workflow->>RatchetCoverage: Run ratchet coverage (after all results)
Workflow->>SaveBaselines: Save baseline files
Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🧰 Additional context used📓 Path-based instructions (1).github/actions/*/action.yml📄 CodeRabbit Inference Engine (AGENTS.md)
Files:
🔇 Additional comments (2)
✨ Finishing Touches🧪 Generate unit tests
🪧 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 (
|
![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 found some issues that need to be addressed.
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: 2
🔭 Outside diff range comments (1)
.github/actions/generate-coverage/action.yml (1)
51-59: Align cache restore with save-key patternThe restore step never hits the cache because the save step appends
${{ github.run_id }}while the restore key is static. Amend the restore step to use the prefix-match mechanism, so the most recent baseline is restored.- key: ratchet-baseline-${{ runner.os }} + key: ratchet-baseline-${{ runner.os }}-${{ github.run_id }} + restore-keys: ratchet-baseline-${{ runner.os }}-
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
.github/actions/generate-coverage/CHANGELOG.md(1 hunks).github/actions/generate-coverage/action.yml(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
.github/actions/*/CHANGELOG.md
📄 CodeRabbit Inference Engine (AGENTS.md)
Each action must have a
CHANGELOG.mdthat follows SemVer-based changelog for that action only.
Files:
.github/actions/generate-coverage/CHANGELOG.md
.github/actions/*/action.yml
📄 CodeRabbit Inference Engine (AGENTS.md)
.github/actions/*/action.yml: Each action must have anaction.ymlfile containing every input and output, with required ones clearly marked.
Composite actions referencing sibling scripts must use${{ github.action_path }}for portability.
Files:
.github/actions/generate-coverage/action.yml
🪛 LanguageTool
.github/actions/generate-coverage/CHANGELOG.md
[uncategorized] ~5-~5: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... ## v1.3.5 - Fix ratchet step ordering so coverage is checked after Python result...
(COMMA_COMPOUND_SENTENCE_2)
🔇 Additional comments (1)
.github/actions/generate-coverage/CHANGELOG.md (1)
3-6: Insert comma before “so” to fix compound sentence- - Fix ratchet step ordering so coverage is checked after Python results are available. + - Fix ratchet step ordering, so coverage is checked after Python results are available.Likely an incorrect or invalid review comment.
1 participant
Summary
Testing
make lintmake testhttps://chatgpt.com/codex/tasks/task_e_6888c22f31388322b885900b2ee99a9d
Summary by Sourcery
Fix the ratchet coverage sequence in the generate-coverage GitHub Action to ensure both Rust and Python coverage are ratcheted after results are generated and update the action changelog to v1.3.5.
Bug Fixes:
Documentation: