Ignore some python formatting errors for licenses #29
+28
−0
Conversation
This file contains hidden or 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
FranzBusch
force-pushed
the
fb-pythong-ignore
branch
from
7ce6075 to
a76979f
Compare
ahoppen
reviewed
Oct 14, 2024
.github/workflows/soundness.yml
Outdated
| pip3 install flake8 flake8-import-order | ||
| cd ${GITHUB_WORKSPACE} | ||
| flake8 | ||
| flake8 --extend-ignore=E265,E266,E501 |
Member
There was a problem hiding this comment.
Completely disabling maximum line length (E501) seems a little to lenient to me. I think projects should be able to enforce that.
What do you think about the following instead?
- Instead of passing an ignore list to
flake8here, we install a default.flake8file to/on the runner. That way we use the default.flake8unless a repo overrides it. - In that default format file, we set
max-line-length = 88, matching what the compiler repo does. This would also fit license header
FranzBusch
force-pushed
the
fb-pythong-ignore
branch
2 times, most recently
from
0664f86 to
86633e6
Compare
# Motivation We want to lint our python files but also need to include our license header. # Modification This PR ignores a few python flake rules to make sure the license headers pass. # Result Passing license headers.
FranzBusch
force-pushed
the
fb-pythong-ignore
branch
from
86633e6 to
6a28afb
Compare
Member
Author
|
The CI failure here is expected since the default conflict is being pulled from main. |
ahoppen
approved these changes
Oct 14, 2024
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.
Motivation
We want to lint our python files but also need to include our license header.
Modification
This PR ignores a few python flake rules to make sure the license headers pass.
Result
Passing license headers.