Skip to content

Comments

Add pre-commit config#151

Merged
ckreibich merged 7 commits intomasterfrom
topic/bbannier/pre-commit
Jan 10, 2023
Merged

Add pre-commit config#151
ckreibich merged 7 commits intomasterfrom
topic/bbannier/pre-commit

Conversation

@bbannier
Copy link
Member

@bbannier bbannier commented Jan 9, 2023

No description provided.

@bbannier bbannier self-assigned this Jan 9, 2023
github-advanced-security[bot]
github-advanced-security bot found potential problems Jan 9, 2023
View reviewed changes
doc/conf.py
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'

html_theme = "sphinx_rtd_theme"

Check notice

Code scanning / CodeQL

Unused global variable

The global variable 'html_theme' is not used.
Copy link
Member Author

@bbannier bbannier Jan 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since Sphinx seems to use magic variables, I am unsure what pattern to use to suppress this warning. Might be worthwhile just manually dismissing this whenever we make an edit to this file. That way we'd still get CodeQL analysis everywhere else (where we are unlikely to use such weird patterns).

@bbannier bbannier force-pushed the topic/bbannier/pre-commit branch from a585d7f to 6aab9b6 Compare January 9, 2023 18:41
@bbannier bbannier marked this pull request as ready for review January 9, 2023 18:42
@bbannier bbannier requested a review from ckreibich January 9, 2023 18:42
ckreibich
ckreibich requested changes Jan 9, 2023
View reviewed changes
Copy link
Member

@ckreibich ckreibich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I look forward to having this in there. One request Benjamin: could you introduce a .git-blame-ignore-revs file covering the reformatting commit, so we keep git blame working? We have that in Zeek too.

https://black.readthedocs.io/en/stable/guides/introducing_black_to_your_project.html#avoiding-ruining-git-blame

@bbannier bbannier force-pushed the topic/bbannier/pre-commit branch from 6aab9b6 to e2e83e0 Compare January 10, 2023 08:58
awelzel
awelzel reviewed Jan 10, 2023
View reviewed changes
awelzel
awelzel reviewed Jan 10, 2023
View reviewed changes
awelzel
awelzel reviewed Jan 10, 2023
View reviewed changes
@bbannier bbannier force-pushed the topic/bbannier/pre-commit branch from e2e83e0 to 2b0f8e7 Compare January 10, 2023 11:17
@bbannier
Reformat Python code with Black.
99520f9
@bbannier
Add .git-blame-ignore-revs file.
d29d7e8
@bbannier
Automatically update Python sources to use python-3.7 syntax.
e5401dc
@bbannier
Make sure files are properly closed in setup.py.
4a28a69 
Even though I am unsure this can actually lead to issues, this was
flagged by CodeQL. Implementing a proper workaround instead of
continously whitelisting these instances.
@bbannier bbannier force-pushed the topic/bbannier/pre-commit branch from 2b0f8e7 to 4a28a69 Compare January 10, 2023 11:27
awelzel
awelzel reviewed Jan 10, 2023
View reviewed changes
@bbannier bbannier requested review from awelzel and ckreibich January 10, 2023 13:26
awelzel
awelzel approved these changes Jan 10, 2023
View reviewed changes
Copy link
Contributor

@awelzel awelzel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving based on skimming through and I like the idea.

@ckreibich ckreibich merged commit b218122 into master Jan 10, 2023
@ckreibich ckreibich deleted the topic/bbannier/pre-commit branch January 10, 2023 20:58
This was referenced Jan 13, 2023
Closed
Merged
@ckreibich ckreibich mentioned this pull request Jan 25, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ckreibich ckreibich ckreibich approved these changes

@awelzel awelzel awelzel approved these changes

Assignees

@bbannier bbannier

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@bbannier @ckreibich @awelzel