Skip to content

✨ Support use as a pre-commit hook#11

Merged
Luttik merged 1 commit intoLuttik:mainfrom
danygielow:add-pre-commit-hook
Oct 8, 2021
Merged

✨ Support use as a pre-commit hook#11
Luttik merged 1 commit intoLuttik:mainfrom
danygielow:add-pre-commit-hook

Conversation

@danygielow
Copy link
Contributor

Hi,

Thank you for implementing this useful tool.
I'd like to use auto-optional in my projects automatically by adding it to my pre-commit pipeline.

This PR adds a config to be able to use it in pre-commit.
I also added a section to the README describing how to use auto-optional with pre-commit.

@Luttik Luttik self-requested a review October 8, 2021 08:18
Copy link
Owner

@Luttik Luttik left a comment

Choose a reason for hiding this comment

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

Hi @danygielow,

This is an amazing idea. I personally don't use pre-commit but I believe it is considered the way to go by many. I have two questions for now.

  1. Is there something that we can add to CI that checks the pre-commit configuration?
  2. Could you add the changes to the README.md also to docs/index.md (I still need a good way to sync the two and maintain relative URLs within mkdocs)?

@codecov-commenter
Copy link

codecov-commenter commented Oct 8, 2021

Codecov Report

Merging #11 (bc596bb) into main (3f904c3) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #11   +/-   ##
=======================================
  Coverage   73.04%   73.04%           
=======================================
  Files           5        5           
  Lines         115      115           
  Branches       21       21           
=======================================
  Hits           84       84           
  Misses         27       27           
  Partials        4        4           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3f904c3...bc596bb. Read the comment docs.

@Luttik Luttik changed the title Add pre-commit hook for running auto-optional ✨ Add pre-commit hook for running auto-optional Oct 8, 2021
@Luttik Luttik changed the title ✨ Add pre-commit hook for running auto-optional ✨ Add pre-commit hook Oct 8, 2021
@Luttik Luttik changed the title ✨ Add pre-commit hook ✨ Support use as a pre-commit hook Oct 8, 2021
@danygielow danygielow force-pushed the add-pre-commit-hook branch from fb37fa6 to bc596bb Compare October 8, 2021 12:19
@Luttik Luttik self-requested a review October 8, 2021 14:37
@Luttik Luttik merged commit 47f4063 into Luttik:main Oct 8, 2021
@Luttik
Copy link
Owner

Luttik commented Oct 8, 2021

Thanks again for your contribution @danygielow I've merged it and a new release action is now running to update the docs.

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.

3 participants