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

Pre-commit support #104

Open
desebjohnston opened this issue Jun 22, 2023 · 1 comment
Open

Pre-commit support #104

desebjohnston opened this issue Jun 22, 2023 · 1 comment

Comments

@desebjohnston
Copy link

Hello! Very nice tool. I just wanted to request official support for pre-commit if at all possible as this would be a very nice integration if working appropriately.

This team from turo has attempted it:
https://github.com/turo/pre-commit-hooks

The problem is the re-embedding seems to always cause a pre-commit failure and re-indexing of the main README.md, so there's an infinite recursion of failure.

@princjef
Copy link
Owner

Hi @desebjohnston, pre-commit is definitely a good use case for this tool. I'm not familiar with the project you mentioned, but I would expect the command to run the same way within a pre-commit hook as it runs under normal execution. If you could provide some details of how gomarkdoc is being invoked or possibly an example where the problematic behavior you're seeing occurs, that will help identify any issues so they can be fixed.

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

No branches or pull requests

2 participants