Add some pre-commit linters and clean tabs and trailing blanks #14872
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
guillaumelambert
force-pushed
the
tox_linters
branch
8 times, most recently
from
cd97b3d to
25c4a10
Compare
guillaumelambert
force-pushed
the
tox_linters
branch
8 times, most recently
from
4d49a53 to
c44899e
Compare
guillaumelambert
force-pushed
the
tox_linters
branch
14 times, most recently
from
81ba881 to
4ee999d
Compare
guillaumelambert
force-pushed
the
tox_linters
branch
4 times, most recently
from
d82355e to
26b0fd5
Compare
guillaumelambert
force-pushed
the
tox_linters
branch
from
78df5e7 to
4e14c10
Compare
- add a pre-commit yaml configuration file with a basic profile to
remove trailing blanks
- add a rule to exclude from its scope
- patch files (generated from git diff)
Trailing blanks are part of their syntax.
- .conf files in the src folder
Their trailing blanks removal make some tests fail during build.
- jinja templates in docker folder
Though trailing blank should not be part of the jinja2 syntax,
these files use a known hack that requires trailing blanks.
Their removal makes build fail.
- create a tox configuration to run/install/uninstall/autoupdate
pre-commit in a python venv
- create a tox profile for the CI
to run pre-commit only on files modified since this commit
- add a shell script to ease running pre-commit inside various CI
Issue sonic-net#15114
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Issue sonic-net#15114 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Issue sonic-net#15114 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
guillaumelambert
force-pushed
the
tox_linters
branch
from
4e14c10 to
b85800f
Compare
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
guillaumelambert
force-pushed
the
tox_linters
branch
from
b424b50 to
1ed3d7a
Compare
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.
Why I did it
ease code review and maintainability
Work item tracking
How I did it
How to verify it
run tox and/or pre-commit locally
Which release branch to backport (provide reason below if selected)
potentially all but not sure