We're already using spotless to format Java code and spotless also supports markdown files <https://github.com/diffplug/spotless/tree/main/plugin-gradle> so maybe worth exploring how we could achieve this through spotless? The main advantage would be that people would be able to catch linting errors already locally before CI runs.
On Thu, Aug 21, 2025 at 5:38 PM Manu Zhang <owenzhang1...@gmail.com> wrote: > Hi all, > > What do you think of adding a GitHub action to lint markdown files? It can > catch markdown rendering issues early and ensure a consistent style across > markdown files. iceberg-python has already included markdown lint[1] in > pre-commit hook. (Thanks Fokko for the suggestion!) > > I've a draft PR[2] that adds a Docs CI triggered on changes to any > markdown files. The lint rules are highly customizable via a config > file[3]. While fixing existing issues spotted by the CI, I'd like to get > early feedback from the community. > > 1. > > https://github.com/apache/iceberg-python/blob/main/.pre-commit-config.yaml#L41 > <https://github.com/apache/iceberg-python/blob/main/.pre-commit-config.yaml#L41> > 2. https://github.com/apache/iceberg/pull/13826 > 3. > https://github.com/manuzhang/iceberg/blob/markdownlint/.markdownlint.jsonc > > Regards, > Manu >
