github: formatting: add check on push and pull-request #810

kkanas · 2024-11-15T19:59:26Z

Add pre-commit to allow local check before commit. This requires installing pre-commit on local machine. Flow to install and check/debug:

pip install pre-commit
pre-commit install
# run pre-commit on single file file_to_check.txt pre-commit run --verbose --files file_to_check.txt # run pre-commit on all files
pre-commit run --verbose --all-files

Rules for pre-commit are in .pre-commit-config.yaml: Currently rules are:

check-added-large-files:
Will stop commit if large files to the repo
mixed-line-ending:
args: ['--fix', 'no']
Reports rule and stops on when file has mixed line endings
will run on all files in repository excluding files ending with .cmd
mixed-line-ending:
args: ['--fix', 'crlf']
files: '.cmd$'
Will automatically correct lf to crlf on files ending with .cmd

To uphold rules on server new github workflow is added that will execute pre-commit run --all-files

Lastly I changed .gitattributes to also force crlf in cmd files.

Description

Describe your changes in as much detail as possible. Provide a link/reference to the issue solved with this request if any.

Checklist

I have read the contribution guidelines.
All unit tests are passing.
I have merged the latest main branch prior to this PR submission.
I submitted this PR against the main branch.

Add pre-commit to allow local check before commit. This requires installing pre-commit on local machine. Flow to install and check/debug: pip install pre-commit pre-commit install \# run pre-commit on single file file_to_check.txt pre-commit run --verbose --files file_to_check.txt \# run pre-commit on all files pre-commit run --verbose --all-files Rules for pre-commit are in .pre-commit-config.yaml: Currently rules are: check-added-large-files: Will stop commit if large files to the repo mixed-line-ending: args: ['--fix', 'no'] Reports rule and stops on when file has mixed line endings will run on all files in repository excluding files ending with .cmd mixed-line-ending: args: ['--fix', 'crlf'] files: '\.cmd$' Will *automatically* correct lf to crlf on files ending with .cmd To uphold rules on server new github workflow is added that will execute pre-commit run --all-files Lastly I changed .gitattributes to also force crlf in cmd files. Signed-off-by: Krzysztof Kanas <[email protected]>

.gitattributes

.pre-commit-config.yaml

.gitattributes

AhmedBM · 2024-11-18T21:50:37Z

@kkanas will this pre-commit hook make git fail when committing anything that invalidates the rules? Sorry im new to these hooks and trying to see the differences/advantages in them.

kkanas · 2024-11-19T15:33:02Z

@kkanas will this pre-commit hook make git fail when committing anything that invalidates the rules? Sorry im new to these hooks and trying to see the differences/advantages in them.

Hi Yes this should fail when you commit anything that invalidates the rules.
I try to summarise:

The .pre-commit-config.yaml consist of rules that will be run by pre-commit run (options)
To run pre-commit locally (on your workstation) you need to install that python package and can either run it:

manually by using command pre-commit run --all-files
locally as pre-commit hook the command pre-commit install install script invocation in .git/hooks/pre-commit
on server when you can run pre-commit as I did in the workflow file

So if we ran this on server we should have build failures when pull request is filed when those rules are not uphold.

Now the how we want to run pre-commit, either in way of showing violation args: ['--fix', 'no'], then locally script will fail on pre-commit.
If you don't add args: ['--fix', 'no'] then pre commit automatically fix violations for you as part of pre commit, you will be stoped before commit with code modified but not committed.

I added .gitattributes and .pre-commit-config.yaml to enforce line endings. Line endings were fixed by running `pre-commit run --all-files` Signed-off-by: Krzysztof Kanas <[email protected]>

…cific Formatting done by running: pre-commit run --all-files Signed-off-by: Krzysztof Kanas <[email protected]>

Signed-off-by: Krzysztof Kanas <[email protected]>

Formatting done by running: pre-commit run --all-files Signed-off-by: Krzysztof Kanas <[email protected]>

Corupus files are exclude due them beeing binary files and new line would construct new corpus with empty line Signed-off-by: Krzysztof Kanas <[email protected]>

Formatting done using: pre-commit run --all-files Signed-off-by: Krzysztof Kanas <[email protected]>

kkanas · 2024-11-19T15:57:56Z

@kkanas will this pre-commit hook make git fail when committing anything that invalidates the rules? Sorry im new to these hooks and trying to see the differences/advantages in them.

AhmedBM
Also look on comments #810 (comment)
and separate commits - hope that helps

AhmedBM

👌

MariusNi · 2024-11-21T19:18:46Z

CONTRIBUTING.md

@@ -27,4 +27,4 @@ The OSConfig Core team will respond to a PR that passes all checks in 3 business

 # Contact

-You may contact the OSConfig Core team at [[email protected]](mailto:[email protected]) to ask questions about OSConfig, to report bugs, to suggest new features, or inquire about any other OSConfig related topic.


Please do not remove this

We need CONTRIBUTING.md restored. It appears it was deleted? (at least on my side). Also, it appears lots of files gained a new EOL at the last line, adding one blank line at the end. Can we remove that? Thanks

MariusNi · 2024-11-21T19:19:28Z

Here and in few more file, it appears that a blank line is added at the end. Can you please check and fix if needed?

Refers to: LICENSE.md:24 in 7dbba03. [](commit_id = 7dbba03, deletion_comment = False)

kkanas requested a review from a team as a code owner November 15, 2024 19:59