feat: lint sh (dragonflyoss#876)

Signed-off-by: Gaius <[email protected]>

.github/workflows/lint.yml

@@ -26,5 +26,6 @@ jobs:
       - name: Markdown lint
         uses: docker://avtodev/markdown-lint:v1
         with:
+          config: '.markdownlint.yml'
           args: '**/*.md'
           ignore: 'deploy/helm-charts manager/console CHANGELOG.md docs/en/api-reference docs/zh-CN/api-reference docs/en/cli-reference/dfget.1.md'

.markdownlint.yml

@@ -0,0 +1,3 @@
+MD010: false
+MD013:
+  line_length: 120

Makefile

@@ -242,6 +242,18 @@ kind-load-manager:
 	@./hack/kind-load.sh manager
 .PHONY: kind-load-manager
 
+# Run code lint
+lint: markdownlint
+	@echo "Begin to golangci-lint."
+	@golangci-lint run
+.PHONY: lint
+
+# Run markdown lint
+markdownlint:
+	@echo "Begin to markdownlint."
+	@./hack/markdownlint.sh
+.PHONY: markdownlint
+
 # Run go generate
 generate:
 	@go generate ${PKG_LIST}
@@ -295,6 +307,8 @@ help:
 	@echo "make kind-load-scheduler            kind load scheduler docker image"
 	@echo "make kind-load-dfdaemon             kind load dfdaemon docker image"
 	@echo "make kind-load-manager              kind load manager docker image"
+	@echo "make lint                           run code lint"
+	@echo "make markdownlint                   run markdown lint"
 	@echo "make swag                           generate swagger api docs"
 	@echo "make changelog                      generate CHANGELOG.md"
 	@echo "make generate                       run go generate"

hack/markdownlint.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+LINT_DIR=/data
+MARKDOWNLINT_IMAGE=avtodev/markdown-lint:v1
+
+docker run --rm \
+    -v "$(PWD):${LINT_DIR}:ro" \
+    ${MARKDOWNLINT_IMAGE} \
+    -c "${LINT_DIR}/.markdownlint.yml" /data/**/*.md \
+    -i "${LINT_DIR}/CHANGELOG.md" \
+    -i "${LINT_DIR}/docs/en/api-reference/api-reference.md" \
+    -i "${LINT_DIR}/docs/en/api-reference" \
+    -i "${LINT_DIR}/deploy/helm-charts" \
+    -i "${LINT_DIR}/docs/zh-CN/api-reference" \
+    -i "${LINT_DIR}/manager/console" \
+    -i "${LINT_DIR}/docs/en/cli-reference/dfget.1.md"