Skip to content

GitHub workflows and pre-commit#2

Merged
LazyTarget merged 4 commits intomainfrom
feature/github-actions
Mar 8, 2025
Merged

GitHub workflows and pre-commit#2
LazyTarget merged 4 commits intomainfrom
feature/github-actions

Conversation

@LazyTarget
Copy link
Owner

@LazyTarget LazyTarget commented Mar 8, 2025

  • Adding CI/CD workflows
  • linting
  • release-drafter
  • sourcery
  • pre-commit

Summary by Sourcery

Adds CI/CD workflows for linting, release drafting, and sourcery, and integrates pre-commit hooks to automate code quality checks.

CI:

  • Adds a workflow for linting using ruff and yamllint.
  • Adds a workflow for release drafting.
  • Adds workflows to run Sourcery on pull requests and on the codebase.

Tests:

  • Adds pre-commit hooks for ruff, yamllint, and sourcery to automate code quality checks.

@sourcery-ai
Copy link

sourcery-ai bot commented Mar 8, 2025

Reviewer's Guide by Sourcery

This pull request introduces CI/CD workflows, pre-commit hooks, and code quality improvements. It adds workflows for linting, release drafting, and sourcery analysis. Pre-commit hooks are configured for code formatting and linting. Minor code formatting and metadata updates are also included. Error handling and logging in the API have been improved.

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

File-Level Changes

Change Details Files
Implemented CI/CD workflows for linting, release drafting, and sourcery analysis.
  • Added a workflow for linting using ruff and yamllint.
  • Integrated release-drafter to automate release note generation.
  • Configured Sourcery workflows for pull requests and codebase analysis.
  • Added a workflow to publish the package to PyPI when a release is created.
.github/workflows/python-publish.yml
.github/release-drafter.yml
.github/workflows/release-drafter.yaml
.github/workflows/lint.yaml
.github/workflows/sourcery-for-pr.yaml
.github/workflows/sourcery-for-codebase.yaml
Integrated pre-commit hooks for code formatting and linting.
  • Configured pre-commit to use ruff for linting and formatting.
  • Added yamllint to pre-commit for YAML file validation.
  • Included Sourcery in pre-commit to suggest code improvements.
.pre-commit-config.yaml
Minor code formatting and metadata updates.
  • Updated the funding model platform in FUNDING.yml.
  • Added newline at end of file in FUNDING.yml.
  • Added a space in example.py.
  • Updated classifiers in setup.py.
FUNDING.yml
example.py
setup.py
Improved error handling and logging in the API.
  • Added logging information when a request limit is exceeded.
  • Ensured content is handled correctly regardless of content type.
  • Fixed a bug where the retry delay was not being calculated correctly.
pyopenhardwaremonitor/api.py

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

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

Overall Comments:

  • Consider using a tool like renovate to keep the pre-commit hooks up to date.
  • The addition of CI/CD workflows and pre-commit hooks is great for code quality and consistency.
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.

@LazyTarget LazyTarget merged commit 15e9867 into main Mar 8, 2025
2 of 3 checks passed
@LazyTarget LazyTarget deleted the feature/github-actions branch March 8, 2025 06:24
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.

1 participant