From a24b7695d74301309e2db997573734bf118069bf Mon Sep 17 00:00:00 2001 From: Ashish Bhatia Date: Tue, 28 Mar 2023 01:23:51 -0700 Subject: [PATCH] Add more code linters --- .github/workflows/lint-markdown.yaml | 44 ++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 .github/workflows/lint-markdown.yaml diff --git a/.github/workflows/lint-markdown.yaml b/.github/workflows/lint-markdown.yaml new file mode 100644 index 00000000..a89ae4ca --- /dev/null +++ b/.github/workflows/lint-markdown.yaml @@ -0,0 +1,44 @@ +--- +# Run this locally with act - https://github.com/nektos/act +# act -j lintMarkdown +name: Lint Markdown + +on: # yamllint disable-line rule:truthy + push: + branches: [main, master] + paths: + - '**.md' + - '.github/workflows/lint-markdown.yaml' + pull_request: + branches: [main, master] + paths: + - '**.md' + - '.github/workflows/lint-markdown.yaml' + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + lintMarkdown: + runs-on: ubuntu-latest + timeout-minutes: 15 + + steps: + - name: Checkout code + uses: actions/checkout@v3 + + - name: Set up Ruby + # See https://github.com/ruby/setup-ruby#versioning + uses: ruby/setup-ruby@v1 + with: + ruby-version: 3.0 + + - name: Install dependencies + run: gem install mdl + + - name: Run tests + # Rule list: https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md + # Don't check for line length (MD013) + # Don't care about list ordering (MD029) + run: mdl --git-recurse --rules ~MD013,~MD029 .