From e712352728a221131602959204c7a2dcf7dcd82b Mon Sep 17 00:00:00 2001
From: Tong Gao <gaotongxiao@gmail.com>
Date: Wed, 8 Dec 2021 15:36:47 +0800
Subject: [PATCH] [Enhancement] Add markdown linter in pre-commit hook (#643)
* [Enhancement] Skip CI when some specific files were changed
* update precommit markdown lint
* circleci precommit hook
---
.circleci/config.yml | 3 +++
.github/workflows/lint.yml | 3 +++
.pre-commit-config.yaml | 6 ++++++
3 files changed, 12 insertions(+)
diff --git a/.circleci/config.yml b/.circleci/config.yml
index b8424ce6..82d8eccd 100644
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@@ -9,6 +9,9 @@ jobs:
- run:
name: Install pre-commit hook
command: |
+ sudo apt-add-repository ppa:brightbox/ruby-ng -y
+ sudo apt-get update
+ sudo apt-get install -y ruby2.7
pip install pre-commit
pre-commit install
- run:
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index 4ef597fa..d456209b 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -13,6 +13,9 @@ jobs:
python-version: 3.7
- name: Install pre-commit hook
run: |
+ sudo apt-add-repository ppa:brightbox/ruby-ng -y
+ sudo apt-get update
+ sudo apt-get install -y ruby2.7
pip install pre-commit
pre-commit install
- name: Linting
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 4134fceb..bd4f748a 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -33,6 +33,12 @@ repos:
args: ["--remove"]
- id: mixed-line-ending
args: ["--fix=lf"]
+ - repo: https://github.com/markdownlint/markdownlint
+ rev: v0.11.0
+ hooks:
+ - id: markdownlint
+ args: ["-r", "~MD002,~MD013,~MD029,~MD033,~MD034",
+ "-t", "allow_different_nesting"]
- repo: https://github.com/myint/docformatter
rev: v1.3.1
hooks: