github: formatting: add check on push and pull-request #810
+37
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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]>
MariusNi
reviewed
Nov 15, 2024
| * text=auto | ||
| *.cmd text eol=crlf |
MariusNi
reviewed
Nov 15, 2024
| )$ | ||
| - id: mixed-line-ending | ||
| args: ['--fix', 'crlf'] | ||
| files: '\.cmd$' |
MariusNi
reviewed
Nov 15, 2024
| args: ['--fix', 'no'] | ||
| exclude: | | ||
| (?x)( | ||
| .*\.cmd |
MariusNi
reviewed
Nov 15, 2024
| )$ | ||
| - id: mixed-line-ending | ||
| args: ['--fix', 'crlf'] | ||
| files: '\.cmd$' |
There was a problem hiding this comment.
Can we achieve the same all via .gitattributes? We can add there exclusions, default conversion, etc.
MariusNi
reviewed
Nov 15, 2024
| * text=auto |
There was a problem hiding this comment.
Can we add here more, like for example:
# Set the default behavior to automatically normalize line endings.
* text=auto
# Explicitly declare text files you want to always be normalized and converted to LF upon checkout.
*.c text eol=lf
*.cpp text eol=lf
*.h text eol=lf
*.txt text eol=lf
*.json text eol=lf
*.yml text eol=lf
*.md text eol=lf
# Denote all files that are truly binary and should not be modified.
*.png binary
*.jpg binary
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
mainbranch prior to this PR submission.mainbranch.