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

[ENH] add pre-commit workflows #44

Merged
merged 6 commits into from
Jul 10, 2024
Merged

[ENH] add pre-commit workflows #44

merged 6 commits into from
Jul 10, 2024

Conversation

Remi-Gau
Copy link
Owner

@Remi-Gau Remi-Gau commented Jul 10, 2024

Summary by Sourcery

This pull request integrates pre-commit hooks into the linting process, adds CI workflows for updating and running pre-commit hooks, and adjusts the dependabot update interval for GitHub Actions.

  • Enhancements:
    • Integrated pre-commit hooks into the linting process in the Makefile.
  • CI:
    • Added a GitHub Actions workflow to update pre-commit hooks on a weekly schedule.
    • Added a GitHub Actions workflow to run pre-commit checks on pull requests and pushes to the main branch.
  • Chores:
    • Changed the dependabot update interval for GitHub Actions from weekly to monthly.
  • unrelated:
    • change yml formatting
    • cancel previous tests runs

Copy link
Contributor

sourcery-ai bot commented Jul 10, 2024

Reviewer's Guide by Sourcery

This pull request enhances the project by integrating pre-commit workflows. The Makefile was updated to install and run pre-commit hooks during the linting process. The dependabot configuration was modified to check for updates monthly instead of weekly. Two new GitHub Actions workflows were added: one to update pre-commit hooks every Monday and create a pull request with the updates, and another to run pre-commit hooks on pull requests and pushes to the main branch.

File-Level Changes

Files Changes
.github/workflows/update_precommit_hooks.yml
.github/workflows/run_precommit.yml
Introduced new GitHub Actions workflows for managing and running pre-commit hooks.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

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

Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟡 Security: 2 issues found
  • 🟢 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 to tell me if it was helpful.

Makefile Show resolved Hide resolved
.github/dependabot.yml Outdated Show resolved Hide resolved
.github/workflows/update_precommit_hooks.yml Outdated Show resolved Hide resolved
.github/workflows/update_precommit_hooks.yml Outdated Show resolved Hide resolved
Copy link

codecov bot commented Jul 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.83%. Comparing base (8f66a87) to head (99b2b0b).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #44   +/-   ##
=======================================
  Coverage   95.83%   95.83%           
=======================================
  Files           7        7           
  Lines          24       24           
=======================================
  Hits           23       23           
  Misses          1        1           
Flag Coverage Δ
macos-latest_matlab-R2023b ?
octave 95.83% <ø> (ø)
ubuntu-latest_matlab-R2021a ?
ubuntu-latest_matlab-R2023b ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Remi-Gau Remi-Gau merged commit b625032 into main Jul 10, 2024
9 checks passed
@Remi-Gau Remi-Gau deleted the lint branch July 10, 2024 00:30
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