From a6cf4c375ecdbf081de1941524add921c545f44c Mon Sep 17 00:00:00 2001 From: luyanbo Date: Tue, 20 Feb 2024 13:39:34 +0800 Subject: [PATCH] add document-lint --- .github/workflows/document-lint.yml | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .github/workflows/document-lint.yml diff --git a/.github/workflows/document-lint.yml b/.github/workflows/document-lint.yml new file mode 100644 index 0000000000..a234fbda33 --- /dev/null +++ b/.github/workflows/document-lint.yml @@ -0,0 +1,25 @@ +name: document-lint + +on: + push: + branches: + - '*' + pull_request: + branches: + - master + - "1.8" + - "2.0" + +jobs: + document-lint: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - run: npm install -g markdownlint-cli + + - name: use markdownlint v0.5.0 to lint markdown file (https://github.com/markdownlint/markdownlint) + run: | + find ./ -name "*.md" | grep -v vendor | grep -v commandline | grep -v .github | grep -v swagger | grep -v api | \ + xargs markdownlint -r --disable MD010 MD013 MD024 MD029 MD033 MD036 --