Skip to content

[Bug]: markdownlint is too verbose #7064

@javorszky

Description

@javorszky

Markdownlint pre-commit hook is overly verbose when it needs to fix files.

Version

edge

What Kubernetes platforms are you running on?

Kind

Steps to reproduce it

  1. Clone repository
  2. Install pre-commit hooks
    1. brew install pre-commit to install the binary if you don't have it yet (and are on mac and have brew)
    2. pre-commit install to install the hooks in the config yaml
    3. pre-commit autoupdate to make sure everything is up to date
  3. Make sure you have at least one .md file with a style violation
  4. Run pre-commit run markdownlint-cli2 --all-files
  5. See a lot of lines similar to this block:
markdownlint-cli2 v0.16.0 (markdownlint v0.36.1)
Finding: site/content/configuration/virtualserver-and-virtualserverroute-resources.md tests/README.md site/content/configuration/security.md site/content/configuration/global-configuration/reporting-resources-status.md site/content/tutorials/oidc-custom-configuration.md examples/shared-examples/custom-log-format/README.md site/content/includes/installation/deploy-controller.md site/content/troubleshooting/troubleshoot-ingress.md site/content/overview/about.md examples/ingress-resources/complete-example/README.md site/developer/README.md site/content/troubleshooting/troubleshoot-configmap-policy.md examples/ingress-resources/daemon-set/README.md site/content/installation/integrations/app-protect-dos/troubleshoot-app-protect-dos.md examples/ingress-resources/jwt/README.md site/content/installation/integrations/_index.md examples/custom-resources/tls-passthrough/README.md examples/custom-resources/custom-ip-listeners/virtualserver/README.md !.github/** !site/**
Linting: 7 file(s)
Summary: 0 error(s)

PR incoming

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugAn issue reporting a potential bugneeds triageAn issue that needs to be triaged

    Type

    No type

    Projects

    Status

    Done 🚀

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions