feat: add pre-commit hook for running the format.sh script

[vinayakkulkarni]

• Added the pre-commit hook as per discussion in proper pre-commit script #3613 & build: add pre-commit script #3622 (comment)

Example:

PS. This also lints the Dockerfiles using Hadolint :)

PPS. Thanks for this amazing open-source software ❤️

[kevinkreiser]

this looks good to me, what do you say @nilsnolde ?

[nilsnolde]

cheeky but that's a really good idea:)

[nilsnolde]

jep thanks a ton @vinayakkulkarni . this should save some serious resources on circleci I hope:)

[nilsnolde]

ah, and don't forget a changelog entry (bottom of the list for new entries)

[vinayakkulkarni]

ah, and don't forget a changelog entry (bottom of the list for new entries)

This gives me an idea of an automation script for doing this instead of manually updating it each time a PR is created

[nilsnolde]

I thought about that recently, where my main motivation was the super annoying merge conflicts resulting from changelog entries and circleci not skipping markdown changes (no good solution came out of thinking/googling).

I understand it's a little annoying and even I forget it sometimes, but any automation would need every contributor to be really decent about either their commit messages or their PR titles I assume right? and how would that deal with merge conflicts resulting from different PRs?

[kevinkreiser]

I would just like to raise one concern. If you merge the docker lint precommit stuff but don't fix the dockerfiles the next person who runs this will be forced to deal with it. I think that's not a very good way to do it. I'd either fix the dockerfiles in this pr or disable the docker linting before merging

[vinayakkulkarni]

I would just like to raise one concern. If you merge the docker lint precommit stuff but don't fix the dockerfiles the next person who runs this will be forced to deal with it. I think that's not a very good way to do it. I'd either fix the dockerfiles in this pr or disable the docker linting before merging

Hey @kevinkreiser, I decided to remove the hadolint in this PR and create a new PR for formatting the Dockerfiles, keeping this PR clean by just installing the the pre-commit CLI & running the scripts/format.sh each time users/contributors commit to their respective branches.