Prevent the auto-doc pre-commit from being run multiple times before merging - Githubissues

bakdata / ci-templates

Collection of reusable workflows and composite actions for Github

MIT License

4 stars 1 forks source link

Prevent the auto-doc pre-commit from being run multiple times before merging #164

Closed MichaelKora closed 5 months ago

MichaelKora commented 6 months ago

Right now, when a documentation file is outdated, the pre-commit / git commit command need to be executed at least three time:

Update the file
Format the file
Run an successful execution

It would be ideal if the command can be just executed once and all of those steps will be at once if needed.

Acceptance Criteria

[ ] When a file is outdated, the git-commit needs to be run just once.
[ ] Up to date files will not be changed.
[ ] Both pre-commit run --all-files and git commit -m"xxxx" have the exact same behaviour.

yannick-roeder commented 5 months ago

Executing it multiple times is the expected behaviour by the pre-commit and there is no parameter to configure this further