Skip to content

Conversation

@spuerta10
Copy link
Owner

@spuerta10 spuerta10 commented Oct 14, 2025

Summary by Sourcery

Add reusable static code analysis workflow and configure CI pipelines for development branches and pull requests to main

CI:

  • Introduce a reusable static code analysis workflow with optional coverage reporting
  • Add dev branch validation workflow to run static analysis and tests without coverage on feature/, feat/, and fix/** pushes
  • Add pull request validation workflow to run static analysis and tests with coverage artifacts on PRs targeting main
  • Remove obsolete top-level static-code-analysis.yml

@spuerta10 spuerta10 self-assigned this Oct 14, 2025
@sourcery-ai
Copy link

sourcery-ai bot commented Oct 14, 2025

Reviewer's Guide

This PR refactors static code analysis into a reusable workflow with parameterized coverage reporting, and introduces separate CI pipelines for dev branch pushes and pull request validations while removing the old monolithic workflow.

Flow diagram for reusable static code analysis workflow

flowchart TD
  A["Workflow Triggered"] --> B["Checkout code"]
  B --> C["Install uv"]
  C --> D["Run Static Code Analysis (pre-commit)"]
  D --> E{"coverage_artifact input?"}
  E -- true --> F["Run unit tests with coverage report (xml & term)"]
  E -- false --> G["Run unit tests with console-only coverage"]
Loading

File-Level Changes

Change Details Files
Create reusable static code analysis workflow with conditional coverage reporting
  • Define workflow_call interface with a boolean input for coverage_artifact
  • Implement steps: checkout, UV install, run pre-commit analysis
  • Run pytest with XML coverage artifact when coverage_artifact=true
  • Run pytest with console-only coverage report when coverage_artifact=false
.github/workflows/ci/static-code-analysis.yml
Add dev branch validation workflow
  • Trigger on push to feature/, feat/, and fix/** branches
  • Invoke the reusable static code analysis workflow with coverage_artifact=false
.github/workflows/ci-dev-branches.yml
Add pull request validation workflow
  • Trigger on pull requests targeting the main branch
  • Invoke the reusable static code analysis workflow with coverage_artifact=true
.github/workflows/pr-validations.yml
Remove legacy static-code-analysis workflow
  • Delete the outdated static-code-analysis.yml in the workflows directory
.github/workflows/static-code-analysis.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

Copy link

@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 there - I've reviewed your changes and they look great!

Blocking issues:

  • An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload. (link)
Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `.github/workflows/ci/static-code-analysis.yml:18` </location>
<code_context>
      uses: astral-sh/setup-uv@v5
</code_context>

<issue_to_address>
**security (yaml.github-actions.security.third-party-action-not-pinned-to-commit-sha):** An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload.

*Source: opengrep*
</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.

@spuerta10 spuerta10 closed this Oct 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants