Skip to content

Commit 4c5f3f0

Browse files
authored
feat: Adding markdownlint v2 to GitHub Actions workflows (#4175)
* feat: Adding markdownlint v2 to GitHub Actions workflows * feat: Adjusting workflow to use committed markdownlint rules
1 parent 450e38f commit 4c5f3f0

File tree

3 files changed

+28
-25
lines changed

3 files changed

+28
-25
lines changed

.circleci/config.yml

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -136,14 +136,6 @@ run_terratest_log_parser: &run_terratest_log_parser
136136
terratest_log_parser --testlog logs/test-results.log --outputdir logs
137137
when: always
138138

139-
run_markdownlint: &run_markdownlint
140-
name: Run markdownlint
141-
command: |
142-
markdownlint \
143-
--disable MD013 MD024 \
144-
-- \
145-
docs
146-
147139
win_install_golang: &win_install_golang
148140
name: Install golang
149141
shell: powershell.exe
@@ -610,13 +602,6 @@ jobs:
610602
- store_test_results:
611603
path: logs
612604

613-
run_markdownlint:
614-
<<: *defaults
615-
steps:
616-
- checkout
617-
- run:
618-
<<: *run_markdownlint
619-
620605
build:
621606
resource_class: xlarge
622607
<<: *defaults
@@ -934,16 +919,6 @@ workflows:
934919
- GCP__automated-tests
935920
- GITHUB__PAT__gruntwork-ci
936921
- APPLE__OSX__code-signing
937-
- run_markdownlint:
938-
filters:
939-
tags:
940-
only:
941-
- /^v.*/
942-
- /^alpha.*/
943-
context:
944-
- AWS__PHXDEVOPS__circle-ci-test
945-
- GCP__automated-tests
946-
- GITHUB__PAT__gruntwork-ci
947922
- build:
948923
filters:
949924
tags:

.github/workflows/markdownlint.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Markdown Lint
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
types: [opened, synchronize, reopened]
9+
10+
jobs:
11+
markdownlint:
12+
name: Run Lint
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Checkout code
16+
uses: actions/checkout@v4
17+
18+
- name: Run markdownlint
19+
uses: DavidAnson/markdownlint-cli2-action@v15
20+
with:
21+
globs: |
22+
docs/**/*.md

.markdownlint-cli2.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
config:
2+
# Disable line length limit
3+
MD013: false
4+
5+
# Disable multiple headers with the same content
6+
MD024: false

0 commit comments

Comments
 (0)