Skip to content

Commit 96fb750

Browse files
authored
Introduce lint-md and compliance-docs pipeline (#24021)
- Add new Make target `lint-md` - Add new Drone pipeline `compliance-docs` - Add `*.md` to docs exclusion/inclusion - Consistently quote `path.include` and `path.exclude` statements in YAML
1 parent 53439e5 commit 96fb750

File tree

2 files changed

+52
-18
lines changed

2 files changed

+52
-18
lines changed

.drone.yml

Lines changed: 47 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ trigger:
1212
- pull_request
1313
paths:
1414
exclude:
15-
- docs/**
15+
- "docs/**"
16+
- "*.md"
1617

1718
volumes:
1819
- name: deps
@@ -181,7 +182,7 @@ trigger:
181182
- pull_request
182183
paths:
183184
exclude:
184-
- docs/**
185+
- "docs/**"
185186

186187
volumes:
187188
- name: deps
@@ -266,6 +267,35 @@ steps:
266267
- name: deps
267268
path: /go
268269

270+
---
271+
kind: pipeline
272+
type: docker
273+
name: compliance-docs
274+
275+
platform:
276+
os: linux
277+
arch: amd64
278+
279+
trigger:
280+
event:
281+
- pull_request
282+
paths:
283+
include:
284+
- "docs/**"
285+
- "*.md"
286+
287+
steps:
288+
- name: deps-frontend
289+
image: node:18
290+
pull: always
291+
commands:
292+
- make deps-frontend
293+
294+
- name: lint-md
295+
image: node:18
296+
commands:
297+
- make lint-md
298+
269299
---
270300
kind: pipeline
271301
type: docker
@@ -283,7 +313,7 @@ trigger:
283313
- pull_request
284314
paths:
285315
exclude:
286-
- docs/**
316+
- "docs/**"
287317

288318
volumes:
289319
- name: deps
@@ -444,7 +474,7 @@ trigger:
444474
- pull_request
445475
paths:
446476
exclude:
447-
- docs/**
477+
- "docs/**"
448478

449479
volumes:
450480
- name: deps
@@ -530,7 +560,7 @@ trigger:
530560
- pull_request
531561
paths:
532562
exclude:
533-
- docs/**
563+
- "docs/**"
534564

535565
volumes:
536566
- name: deps
@@ -616,7 +646,7 @@ trigger:
616646
- pull_request
617647
paths:
618648
exclude:
619-
- docs/**
649+
- "docs/**"
620650

621651
volumes:
622652
- name: deps
@@ -696,7 +726,7 @@ trigger:
696726
- pull_request
697727
paths:
698728
exclude:
699-
- docs/**
729+
- "docs/**"
700730

701731
volumes:
702732
- name: deps
@@ -867,7 +897,7 @@ trigger:
867897
- push
868898
paths:
869899
exclude:
870-
- docs/**
900+
- "docs/**"
871901

872902
depends_on:
873903
- testing-mysql
@@ -1125,7 +1155,7 @@ trigger:
11251155
- pull_request
11261156
paths:
11271157
include:
1128-
- docs/**
1158+
- "docs/**"
11291159

11301160
steps:
11311161
- name: build-docs
@@ -1176,7 +1206,7 @@ trigger:
11761206
- cron
11771207
paths:
11781208
exclude:
1179-
- docs/**
1209+
- "docs/**"
11801210

11811211
steps:
11821212
- name: fetch-tags
@@ -1253,7 +1283,7 @@ trigger:
12531283
- cron
12541284
paths:
12551285
exclude:
1256-
- docs/**
1286+
- "docs/**"
12571287

12581288
steps:
12591289
- name: fetch-tags
@@ -1468,7 +1498,7 @@ trigger:
14681498
- pull_request
14691499
paths:
14701500
exclude:
1471-
- docs/**
1501+
- "docs/**"
14721502

14731503
steps:
14741504
- name: dryrun
@@ -1515,7 +1545,7 @@ trigger:
15151545
- cron
15161546
paths:
15171547
exclude:
1518-
- docs/**
1548+
- "docs/**"
15191549

15201550
steps:
15211551
- name: fetch-tags
@@ -1592,7 +1622,7 @@ trigger:
15921622
- cron
15931623
paths:
15941624
exclude:
1595-
- docs/**
1625+
- "docs/**"
15961626

15971627
steps:
15981628
- name: fetch-tags
@@ -1667,7 +1697,7 @@ trigger:
16671697
- cron
16681698
paths:
16691699
exclude:
1670-
- docs/**
1700+
- "docs/**"
16711701

16721702
steps:
16731703
- name: fetch-tags
@@ -1834,7 +1864,7 @@ trigger:
18341864
- cron
18351865
paths:
18361866
exclude:
1837-
- docs/**
1867+
- "docs/**"
18381868

18391869
depends_on:
18401870
- docker-linux-amd64-release-version
@@ -1884,7 +1914,7 @@ trigger:
18841914
- cron
18851915
paths:
18861916
exclude:
1887-
- docs/**
1917+
- "docs/**"
18881918

18891919
depends_on:
18901920
- docker-linux-amd64-release

Makefile

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,7 @@ help:
196196
@echo " - lint lint everything"
197197
@echo " - lint-frontend lint frontend files"
198198
@echo " - lint-backend lint backend files"
199+
@echo " - lint-md lint markdown files"
199200
@echo " - checks run various consistency checks"
200201
@echo " - checks-frontend check frontend files"
201202
@echo " - checks-backend check backend files"
@@ -341,10 +342,13 @@ checks-backend: tidy-check swagger-check fmt-check misspell-check swagger-valida
341342
lint: lint-frontend lint-backend
342343

343344
.PHONY: lint-frontend
344-
lint-frontend: node_modules
345+
lint-frontend: node_modules lint-md
345346
npx eslint --color --max-warnings=0 --ext js,vue web_src/js build *.config.js docs/assets/js tests/e2e
346347
npx stylelint --color --max-warnings=0 web_src/css
347348
npx spectral lint -q -F hint $(SWAGGER_SPEC)
349+
350+
.PHONY: lint-md
351+
lint-md: node_modules
348352
npx markdownlint docs *.md
349353

350354
.PHONY: lint-backend

0 commit comments

Comments
 (0)