Skip to content
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

chore(ci): run pre-commit on licence update #831

Merged
merged 1 commit into from
Feb 1, 2025

Conversation

abn
Copy link
Member

@abn abn commented Feb 1, 2025

Closes: #829

Summary by Sourcery

CI:

  • Run pre-commit on licence update.

Copy link

sourcery-ai bot commented Feb 1, 2025

Reviewer's Guide by Sourcery

This pull request modifies the CI workflow to run pre-commit after updating the licenses list.

Sequence diagram for updated license update workflow

sequenceDiagram
    participant CI as CI Workflow
    participant Python as Python Script
    participant PreCommit as Pre-commit

    CI->>Python: Run spdx/helpers.py
    Python-->>CI: Update licenses list
    CI->>PreCommit: Run pre-commit on all files
    PreCommit-->>CI: Format and check files
Loading

Flow diagram for the updated license update CI process

flowchart LR
    Start[Start Workflow] --> UpdateLicenses[Update Licenses List]
    UpdateLicenses --> PreCommit[Run Pre-commit]
    PreCommit --> Token[Generate Token]
    Token --> End[End Workflow]
Loading

File-Level Changes

Change Details Files
Run pre-commit after updating the licenses list.
  • Added a step to run pre-commit after updating the licenses list.
.github/workflows/update-licenses.yaml

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

@abn abn requested a review from a team February 1, 2025 01:19
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 @abn - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Using || : to ignore pre-commit failures is concerning - this could mask real issues. Either handle failures properly or document why they need to be ignored in this specific workflow.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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.

@abn abn enabled auto-merge (rebase) February 1, 2025 01:44
@abn abn merged commit ad5f274 into python-poetry:main Feb 1, 2025
18 checks passed
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