From 4d191daaaee8b9a72780ddfdfc71d06972d942e9 Mon Sep 17 00:00:00 2001 From: msteslov Date: Mon, 25 May 2026 11:24:00 +0300 Subject: [PATCH] Add Markdown documentation linting Signed-off-by: msteslov --- .github/workflows/basic.yml | 12 ++++++++++++ .rumdl.toml | 25 +++++++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 .rumdl.toml diff --git a/.github/workflows/basic.yml b/.github/workflows/basic.yml index c97d25071b..ea02a8bff9 100644 --- a/.github/workflows/basic.yml +++ b/.github/workflows/basic.yml @@ -34,6 +34,18 @@ jobs: - name: Validate CBOM run: scripts/validate_cbom.sh + markdownlint: + name: Check Markdown documentation + needs: [workflowcheck] + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # pin@v4 + - name: Install rumdl + run: python3 -m pip install --user rumdl==0.2.4 + - name: Ensure Markdown conventions are upheld + run: ~/.local/bin/rumdl check --config .rumdl.toml --respect-gitignore --exclude "build,**/build" . + upstreamcheck: name: Check upstream code is properly integrated needs: [workflowcheck] diff --git a/.rumdl.toml b/.rumdl.toml new file mode 100644 index 0000000000..7e7b1ddf60 --- /dev/null +++ b/.rumdl.toml @@ -0,0 +1,25 @@ +[global] +# Keep the initial lint configuration focused on Markdown rules that match the +# existing documentation style and do not require unrelated documentation churn. +enable = [ + "MD001", # heading-increment + "MD004", # ul-style + "MD011", # no-reversed-links + "MD014", # commands-show-output + "MD018", # no-missing-space-atx + "MD019", # no-multiple-space-atx + "MD020", # no-missing-space-closed-atx + "MD021", # no-multiple-space-closed-atx + "MD023", # heading-start-left + "MD026", # no-trailing-punctuation + "MD027", # no-multiple-space-blockquote + "MD028", # no-blanks-blockquote + "MD035", # hr-style + "MD037", # no-space-in-emphasis + "MD039", # no-space-in-links + "MD042", # no-empty-links + "MD043", # required-headings + "MD044", # proper-names + "MD045", # no-alt-text + "MD048", # code-fence-style +]