From d9320277e17d2c4efbf5c30f135fcdf923abe7f1 Mon Sep 17 00:00:00 2001 From: Sylvestre Ledru Date: Fri, 3 Mar 2023 18:42:51 +0100 Subject: [PATCH] Run the markdown linter in the CI --- .github/workflows/CICD.yml | 8 +++++++- .markdownlint.yaml | 6 ++++++ 2 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 .markdownlint.yaml diff --git a/.github/workflows/CICD.yml b/.github/workflows/CICD.yml index cf12ee2d7..b3afe5c59 100644 --- a/.github/workflows/CICD.yml +++ b/.github/workflows/CICD.yml @@ -291,7 +291,13 @@ jobs: shell: bash run: | RUSTDOCFLAGS="-Dwarnings" cargo doc ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }} --no-deps --workspace --document-private-items - + - uses: DavidAnson/markdownlint-cli2-action@v9 + with: + command: fix + globs: | + *.md + docs/src/*.md + src/uu/*/*.md min_version: name: MinRustV # Minimum supported rust version (aka, MinSRV or MSRV) diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 000000000..11b733e0b --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,6 @@ +# Disable 'Line length'. Doesn't provide much values +MD013: false +# Disable 'Fenced code blocks should have a language specified' +# Doesn't provide much in src/ to enforce it +MD040: false +