How to handle infra status checks after pre-commit autoupdate?

Beman Infra
1

After pre-commit autoupdate, files from infra may be new formatted.

What is to do now?

see Feat: apply precommit autoupdate by ClausKlein · Pull Request #1 · ClausKlein/scope · GitHub

2

same problem here:

bash-5.3$ pre-commit run --all
trim trailing whitespace.................................................Passed
fix end of files.........................................................Passed
check yaml...............................................................Passed
check for added large files..............................................Passed
clang-format.............................................................Passed
markdownlint.............................................................Failed
- hook id: markdownlint
- exit code: 1

infra/README.md:19 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
infra/README.md:22 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
infra/README.md:53:120 MD013/line-length Line length [Expected: 119; Actual: 127]
infra/README.md:55:120 MD013/line-length Line length [Expected: 119; Actual: 275]

codespell................................................................Passed
bash-5.3$ git status
On branch feature/support_apple_clang
Your branch is up to date with 'origin/feature/support_apple_clang'.

nothing to commit, working tree clean
bash-5.3$

see Feature/support apple clang by ClausKlein · Pull Request #7 · bemanproject/bounds_test · GitHub

3

One possible solution is:

bash-5.3$ git diff
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 8bc6d2d..93b5f35 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -38,3 +38,5 @@ repos:
     rev: v2.4.1
     hooks:
       - id: codespell
+
+exclude: 'infra/'
bash-5.3$
4

So I don’t think we followed up on this in exemplar/infra, but most of us are mostly annoyed by the markdown lint and have turned it off completely. @ednolan any thoughts on this?

5

This is a specific case of a more general problem, which is that we have a lot of repositories that are based on old versions of exemplar so don’t have all its latest fixes-- I have some ideas in mind to address that bigger problem, but in exemplar itself, we already exclude infra in the pre-commit config as of a couple months ago:

And we comment out the markdown lint by default and leave it up to the user if they want to re-enable it:

@ClausKlein, please feel free to apply either or both of those changes to your own repository.

2 Likes
6

The defaults in markdown lint are very style opinionated. I want something to tell me I’ve probably missed a mandatory bit of whitespace, but not complain that a URL has pushed a line past 80 columns. For text, other than prog-lang text, I use visual wrap, like a wordprocessor, so I don’t care.
But infra since it has it’s own configs should be excluded from the checks of whatever its vendored into, generally, not just for markdown.