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

fix: Ensure linting always applied #845

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Mr-Sunglasses
Copy link

@Mr-Sunglasses Mr-Sunglasses commented Feb 17, 2025

fix: #825

Summary by Sourcery

This pull request updates the CI workflow to automatically format code and ensure that linting issues fail the build.

CI:

  • The CI workflow now automatically formats code and commits the changes to the branch.
  • The CI workflow now fails if linting issues are found.

Copy link
Contributor

sourcery-ai bot commented Feb 17, 2025

Reviewer's Guide by Sourcery

This pull request ensures that linting errors will cause the CI build to fail. It also adds an auto-formatting step to the CI workflow.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Ensured that linting errors will cause the CI build to fail.
  • The make lint command now includes `
Added an auto-formatting step to the CI workflow.
  • Added a step to run make format.
  • Added a step to automatically commit the formatted code.
.github/workflows/ci.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!
  • 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

Copy link
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 @Mr-Sunglasses - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider combining the lint and format steps into a single job to simplify the workflow.
  • Committing changes from the auto-formatter might trigger another CI run; consider how to avoid an infinite loop.
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.

@rhatdan
Copy link
Member

rhatdan commented Feb 18, 2025

You need to sign your commits.

git commit -a --amend -s
git push --force

@rhatdan
Copy link
Member

rhatdan commented Feb 18, 2025

LGTM


- name: Auto-format code
run: |
make format
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer to not create an automated commit just for formatting and simply check for it:

Suggested change
make format
make check-format || exit 1

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not just:

"make check-format"

"|| exit 1" will just hide the original exit code. If it's false, it should fail anyway (false is non-zero in bash)

@@ -25,7 +25,16 @@ jobs:

- name: Run lint
run: |
make lint
# Ensure linting fails the build if issues are found
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NIT: The comment can be removed

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.

Ensure linting always applied
4 participants