scripts/ci: add markdown linter check

Check markdown linting each time we run the test
to avoid already fixed styling issues.

Change-Id: I34dca3217e5119e6cb71c1f4512beb0c40c50840
Signed-off-by: Karol Latecki <[email protected]>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk-csi/+/7308
Reviewed-by: Antti Kervinen <[email protected]>
Reviewed-by: Yibo Cai <[email protected]>
Reviewed-by: Pawel Piatek <[email protected]>
Reviewed-by: Jaroslaw Chachulski <[email protected]>
Reviewed-by: Krzysztof Karas <[email protected]>
Reviewed-by: Kamil Godzwon <[email protected]>
Tested-by: SPDK CI Jenkins <[email protected]>

Author: Karol Latecki

Makefile

@@ -45,7 +45,7 @@ spdkcsi:
 	@CGO_ENABLED=0 GOARCH=$(GOARCH) GOOS=linux go build -buildvcs=false -o $(OUT_DIR)/spdkcsi ./cmd/
 
 # static code check, text lint
-lint: golangci yamllint shellcheck
+lint: golangci yamllint shellcheck mdl
 
 .PHONY: golangci
 golangci: $(GOLANGCI_BIN)
@@ -76,6 +76,16 @@ shellcheck:
 	     echo shellcheck not installed, skip test;                       \
 	 fi
 
+.PHONY: mdl
+mdl:
+	@echo === running mdl
+	@if hash mdl 2> /dev/null; then                                      \
+		find ./ -name "*.md" | xargs readlink -f  | xargs mdl --style scripts/ci/mdl_rules.rb; \
+	else                                                                 \
+	    echo Markdown linter not found, please install;                  \
+	    false                                          ;                 \
+	fi
+
 # tests
 test: mod-check unit-test
 

scripts/ci/common.sh

@@ -106,9 +106,10 @@ function install_packages_ubuntu() {
 	systemctl start docker
 	# install static check tools only on x86 agent
 	if [ "$(arch)" == x86_64 ]; then
-		apt-get install -y python3-pip
+		apt-get install -y python3-pip ruby
 		pip3 install yamllint==1.23.0 shellcheck-py==0.7.1.1
 	fi
+	gem install mdl -v 0.12.0
 }
 
 function install_packages_fedora() {
@@ -119,7 +120,8 @@ function install_packages_fedora() {
 					conntrack \
 					bind-utils \
 					socat \
-					wget
+					wget \
+					ruby
 	if ! hash docker &> /dev/null; then
 		dnf remove -y docker*
 		dnf install -y dnf-plugins-core
@@ -132,9 +134,10 @@ function install_packages_fedora() {
 
 	# install static check tools only on x86 agent
 	if [ "$(arch)" == x86_64 ]; then
-		dnf install -y python3-pip
+		dnf install -y python3-pip ruby
 		pip3 install yamllint==1.23.0 shellcheck-py==0.7.1.1
 	fi
+	gem install mdl -v 0.12.0
 }
 
 function install_golang() {

scripts/ci/mdl_rules.rb

@@ -0,0 +1,4 @@
+all
+rule 'MD013', :line_length => 120
+rule 'MD029', :style => "ordered"
+exclude_rule 'MD031'