Consolidate instruction casing lint rules #5046
Conversation
There was a problem hiding this comment.
Needs a make docs-dockerfile
Also you can delete the doc template under https://github.com/daghack/buildkit/tree/consolidate-case-checks/frontend/dockerfile/linter/docs
https://github.com/moby/buildkit/actions/runs/9550007600/job/26320979434?pr=5046#step:5:380
daghack
force-pushed
the
consolidate-case-checks
branch
from
5e53b3b
to
33742cc
Compare
Signed-off-by: Talon Bowler <talon.bowler@docker.com>
daghack
force-pushed
the
consolidate-case-checks
branch
from
33742cc
to
8cbb98e
Compare
You beat me to it, ty! |
| return fmt.Sprintf("Command '%s' should be consistently cased", command) | ||
| }, | ||
| } | ||
| RuleFileConsistentCommandCasing = LinterRule[func(string, string) string]{ |
There was a problem hiding this comment.
Maybe not needed yet, but generally I think we need to keep old rules/URLs in here so the docs are still generated for them. Otherwise old client will hit issue, click on a link and get 404
There was a problem hiding this comment.
That's a good thought to bring up, and you're definitely right. There may be a case for adding some sort of Deprecated flag to the ruleset so that documentation can automatically note it as such as follow-up work.
Currently, there are two lint checks that look at the casing of instructions, but they are largely redundant. This consolidates the two checks into a single casing check.