Skip to content

Refactor coverage action#15

Open
leynos wants to merge 3 commits intomainfrom
codex/merge-detect-and-validate-steps-in-coverage-workflow
Open

Refactor coverage action#15
leynos wants to merge 3 commits intomainfrom
codex/merge-detect-and-validate-steps-in-coverage-workflow

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 24, 2025

Summary

  • merge project detection and format validation into one step in the generate-coverage action
  • document the change in the changelog

Testing

  • git status --short

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

Summary by Sourcery

Streamline the generate-coverage action by consolidating language detection and format validation into one step and bump its changelog to v1.1.2

Enhancements:

  • Merge project detection and format validation into a single step in the generate-coverage action

Documentation:

  • Update changelog to v1.1.2 and document the merged detection and validation step

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 24, 2025

Reviewer's Guide

This PR refactors the generate-coverage action by merging project detection and format validation into a single Bash step and updates the action’s changelog accordingly.

Flow diagram for merged project detection and format validation in generate-coverage action

flowchart TD
    A[Start] --> B{Check for Cargo.toml and/or pyproject.toml}
    B -->|Both present| C[Fail: Not supported]
    B -->|Cargo.toml only| D[Set lang=rust]
    B -->|pyproject.toml only| E[Set lang=python]
    B -->|Neither| F[Fail: Not found]
    D --> G{Validate format input}
    E --> G
    G -->|Valid| H[Check lang/format compatibility]
    G -->|Invalid| I[Fail: Invalid format]
    H -->|lang=rust & format=coveragepy| J[Fail: Not supported]
    H -->|lang=python & format=lcov| K[Fail: Not supported]
    H -->|Supported| L[Set output lang]
    L --> M[End]
Loading

File-Level Changes

Change Details Files
Updated changelog to document the merged detection/validation step and bump version
  • Bumped version to v1.1.2 dated 2025-06-25
  • Added entry describing merge of detection and validation
  • Consolidated and reordered existing v1.1.0 entries
.github/actions/generate-coverage/CHANGELOG.md
Consolidated detection of project type and format validation into one step
  • Removed separate validate step and its shell declarations
  • Inlined format case validation into the initial detection step
  • Replaced direct GitHub output in detect step with a lang variable and single echo "lang=$lang" at end
.github/actions/generate-coverage/action.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 24, 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 59 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 1176665 and 0a8ef45.

📒 Files selected for processing (2)
  • .github/actions/generate-coverage/CHANGELOG.md (1 hunks)
  • .github/actions/generate-coverage/action.yml (5 hunks)

Summary by CodeRabbit

  • Chores

    • Updated the changelog with a new version entry and reorganised previous entries for clarity.
  • Refactor

    • Improved the workflow for language detection and validation in the coverage action, streamlining the process and enhancing environment variable usage.

Summary by CodeRabbit

  • Documentation

    • Updated the changelog with a new version entry and reorganised previous entries for clarity.
  • Refactor

    • Simplified workflow by merging detection and validation steps, improving efficiency in language handling.

Walkthrough

The changelog for the generate-coverage GitHub Action was updated with a new version entry describing the consolidation of detection and validation steps. The action workflow was modified to assign the detected language to a local variable, perform validation using this variable, and write the output only after validation, simplifying the workflow.

Changes

File(s) Change Summary
.github/actions/generate-coverage/CHANGELOG.md Added entry for version 1.1.2 describing merged detection and validation steps; reordered entries
.github/actions/generate-coverage/action.yml Refactored workflow: detection assigns to local variable, validation uses it, output written once

Sequence Diagram(s)

sequenceDiagram
    participant Workflow
    participant Detection
    participant Validation
    participant Output

    Workflow->>Detection: Detect project language
    Detection-->>Workflow: Assign language to local variable (lang)
    Workflow->>Validation: Validate format compatibility with lang
    Validation-->>Workflow: Pass/fail validation
    Workflow->>Output: Write lang to GitHub Actions output (after validation)
Loading

Possibly related PRs

Poem

A rabbit hops through workflow code,
Merging steps along its road.
Detect, then check, then out it goes—
Simpler paths the bunny chose.
With changelogs neat and actions clear,
The coverage dance brings cheer!
🐇✨

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch codex/merge-detect-and-validate-steps-in-coverage-workflow

🪧 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 auto-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
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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between aa19e61 and ecd7a69.

📒 Files selected for processing (2)
  • .github/actions/generate-coverage/CHANGELOG.md (1 hunks)
  • .github/actions/generate-coverage/action.yml (2 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
`.github/actions/*/CHANGELOG.md`: Each action must have a CHANGELOG.md tracking SemVer-based changes for that action only.

.github/actions/*/CHANGELOG.md: Each action must have a CHANGELOG.md tracking SemVer-based changes for that action only.

  • .github/actions/generate-coverage/CHANGELOG.md
`.github/actions/*/action.yml`: Each action must have an action.yml file containing all inputs and outputs, with required ones clearly marked.

.github/actions/*/action.yml: Each action must have an action.yml file containing all inputs and outputs, with required ones clearly marked.

  • .github/actions/generate-coverage/action.yml
🪛 LanguageTool
.github/actions/generate-coverage/CHANGELOG.md

[uncategorized] ~16-~16: A determiner appears to be missing. Consider inserting it.
Context: ...- Expose file and format outputs. - Default coverage format changed to cobertura....

(AI_EN_LECTOR_MISSING_DETERMINER)

🔇 Additional comments (2)
.github/actions/generate-coverage/action.yml (1)

39-46: Consolidated detection logic looks sound

Assigning the detected language to a local lang variable instead of immediately emitting an output is clean and prevents an unnecessary write in failure scenarios. All following guards correctly reference the variable, so behaviour is preserved.

.github/actions/generate-coverage/CHANGELOG.md (1)

3-6: Changelog entry is clear and follows SemVer

The new v1.1.2 bullet concisely documents the workflow simplification and keeps chronological order intact.

Comment thread .github/actions/generate-coverage/action.yml Outdated
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: 2

🔭 Outside diff range comments (1)
.github/actions/generate-coverage/action.yml (1)

47-63: Validation can be collapsed for easier maintenance

You now perform three separate checks:

  1. case whitelist
  2. rust + coveragepy mismatch
  3. python + lcov mismatch

These can be merged into a single guarded match to avoid future drift:

-case "${{ inputs.format }}" in
-  lcov|cobertura|coveragepy) ;;
-  *) echo "Unsupported format: ${{ inputs.format }}" >&2; exit 1 ;;
-esac
-
-if [[ "$lang" == 'rust' && "${{ inputs.format }}" == 'coveragepy' ]]; then
-  echo "coveragepy format only supported for Python projects" >&2
-  exit 1
-fi
-if [[ "$lang" == 'python' && "${{ inputs.format }}" == 'lcov' ]]; then
-  echo "lcov format only supported for Rust projects" >&2
-  exit 1
-fi
+case "$lang:${{ inputs.format }}" in
+  rust:lcov|rust:cobertura|python:cobertura|python:coveragepy) ;;
+  rust:* )
+    echo "Format ${{ inputs.format }} not supported for Rust" >&2; exit 1 ;;
+  python:* )
+    echo "Format ${{ inputs.format }} not supported for Python" >&2; exit 1 ;;
+  * )
+    echo "Unsupported lang/format combination" >&2; exit 1 ;;
+esac

One switch statement both whitelists and enforces compatibility.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ecd7a69 and 1176665.

📒 Files selected for processing (2)
  • .github/actions/generate-coverage/CHANGELOG.md (1 hunks)
  • .github/actions/generate-coverage/action.yml (5 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
`.github/actions/*/action.yml`: Each action must have an action.yml file containing all inputs and outputs, with required ones clearly marked.

.github/actions/*/action.yml: Each action must have an action.yml file containing all inputs and outputs, with required ones clearly marked.

  • .github/actions/generate-coverage/action.yml
`.github/actions/*/CHANGELOG.md`: Each action must have a CHANGELOG.md tracking SemVer-based changes for that action only.

.github/actions/*/CHANGELOG.md: Each action must have a CHANGELOG.md tracking SemVer-based changes for that action only.

  • .github/actions/generate-coverage/CHANGELOG.md
🪛 LanguageTool
.github/actions/generate-coverage/CHANGELOG.md

[uncategorized] ~16-~16: A determiner appears to be missing. Consider inserting it.
Context: ...- Expose file and format outputs. - Default coverage format changed to cobertura....

(AI_EN_LECTOR_MISSING_DETERMINER)

🔇 Additional comments (4)
.github/actions/generate-coverage/action.yml (3)

39-42: Local lang variable is now correctly scoped – duplication removed

Assigning the detected language to a local shell variable and deferring public exposure until the out step eliminates the double-write noted in the previous review. Nice clean-up.


64-64: Environment export is clear and avoids clobbering LANG

Using LANG_DETECTED sidesteps the well-known LANG locale variable, preventing subtle locale issues on Linux runners.


66-99: Confirm that env.LANG_DETECTED is visible in the if: expression

if: conditions are evaluated before the step starts; they rely on the job-level environment rather than the runtime shell environment. In most cases values written to $GITHUB_ENV by an earlier step are propagated, but this behaviour can be brittle.

Please re-run a smoke workflow (one Rust repo and one Python repo) to ensure the Rust/Python branches are still taken as expected.

.github/actions/generate-coverage/CHANGELOG.md (1)

3-6: Changelog entry is clear and well-scoped

Entry accurately documents the functional change and the new environment variable.

Comment thread .github/actions/generate-coverage/action.yml
Comment thread .github/actions/generate-coverage/CHANGELOG.md
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