Skip to content

Commit 14a68cf

Browse files
castastrophecastastrophe
committed
build: add markdownlint tooling
1 parent 57d0275 commit 14a68cf

File tree

105 files changed

+5055
-28155
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

105 files changed

+5055
-28155
lines changed

‎.github/actions/file-diff/CHANGELOG.md‎

Lines changed: 12 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -14,56 +14,46 @@
1414
- [#3488](https://github.com/adobe/spectrum-css/pull/3488) [`40c1954`](https://github.com/adobe/spectrum-css/commit/40c1954048f735a07f9edfccf3a568d38164806a) Thanks [@castastrophe](https://github.com/castastrophe)!
1515
- Update file table to specify if the file is deleted/moved and indicate the file size has decreased without showing percentages. This update also hardens the way in which the main file is highlighted in the table by checking for exact equals for looking for files "ending with" the file name.
1616

17+
- Update file table to specify if the file is deleted/moved and indicate the file size has decreased without showing percentages. This update also hardens the way in which the main file is highlighted in the table by checking for exact equals for looking for files "ending with" the file name.
18+
1719
## 2.0.6
1820

1921
### Patch Changes
2022

2123
- [#2775](https://github.com/adobe/spectrum-css/pull/2775) [`2452637`](https://github.com/adobe/spectrum-css/commit/2452637d1179b9b2b025dafeb5834720712413d7) Thanks [@castastrophe](https://github.com/castastrophe)!
2224
- Dependency minor and patch updates to support new features in tools leveraged
2325

24-
<a name="2.0.5"></a>
25-
26-
##2.0.5
26+
## 2.0.5
2727

2828
🗓 2024-03-07 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/gh-action-file-diff@2.0.4...@spectrum-tools/gh-action-file-diff@2.0.5)
2929

3030
**Note:** Version bump only for package @spectrum-tools/gh-action-file-diff
3131

32-
<a name="2.0.4"></a>
33-
34-
##2.0.4
32+
## 2.0.4
3533

3634
🗓 2024-02-12 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/gh-action-file-diff@2.0.3...@spectrum-tools/gh-action-file-diff@2.0.4)
3735

3836
**Note:** Version bump only for package @spectrum-tools/gh-action-file-diff
3937

40-
<a name="2.0.3"></a>
41-
42-
##2.0.3
38+
## 2.0.3
4339

44-
🗓 2024-02-06
40+
🗓 2024-02-06 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/gh-action-file-diff@2.0.2...@spectrum-tools/gh-action-file-diff@2.0.3)
4541

4642
**Note:** Version bump only for package @spectrum-tools/gh-action-file-diff
4743

48-
<a name="2.0.2"></a>
49-
50-
##2.0.2
44+
## 2.0.2
5145

5246
🗓 2024-01-29 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/gh-action-file-diff@2.0.1...@spectrum-tools/gh-action-file-diff@2.0.2)
5347

5448
**Note:** Version bump only for package @spectrum-tools/gh-action-file-diff
5549

56-
<a name="2.0.1"></a>
57-
58-
##2.0.1
50+
## 2.0.1
5951

6052
🗓 2024-01-16 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/gh-action-file-diff@2.0.0...@spectrum-tools/gh-action-file-diff@2.0.1)
6153

6254
**Note:** Version bump only for package @spectrum-tools/gh-action-file-diff
6355

64-
<a name="2.0.0"></a>
65-
66-
#2.0.0
56+
## 2.0.0
6757

6858
🗓 2023-12-12 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/gh-action-file-diff@1.0.2...@spectrum-tools/gh-action-file-diff@2.0.0)
6959

@@ -75,17 +65,13 @@
7565

7666
- NEW: @spectrum-css/ui-icons package for all SVG icons in the UI set.
7767

78-
<a name="1.0.2"></a>
68+
## 1.0.2
7969

80-
##1.0.2
81-
82-
🗓 2023-11-15
70+
🗓 2023-11-15 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/gh-action-file-diff@1.0.1...@spectrum-tools/gh-action-file-diff@1.0.2)
8371

8472
**Note:** Version bump only for package @spectrum-tools/gh-action-file-diff
8573

86-
<a name="1.0.1"></a>
87-
88-
##1.0.1
74+
## 1.0.1
8975

9076
🗓 2023-11-13
9177

‎.github/workflows/development.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,8 @@ jobs:
8585
styles_modified_files: ${{ steps.changed-files.outputs.styles_modified_files }}
8686
eslint_added_files: ${{ steps.changed-files.outputs.eslint_added_files }}
8787
eslint_modified_files: ${{ steps.changed-files.outputs.eslint_modified_files }}
88+
mdlint_added_files: ${{ steps.changed-files.outputs.mdlint_added_files }}
89+
mdlint_modified_files: ${{ steps.changed-files.outputs.mdlint_modified_files }}
8890
plugins_modified_files: ${{ steps.changed-files.outputs.plugins_modified_files }}
8991
plugins_added_files: ${{ steps.changed-files.outputs.plugins_added_files }}
9092
permissions:
@@ -100,6 +102,17 @@ jobs:
100102
- components/*/index.css
101103
eslint:
102104
- components/*/stories/*.js
105+
mdlint:
106+
- *.md
107+
- .storybook/*.md
108+
- .storybook/*/*.md
109+
- .storybook/*/*.mdx
110+
- components/*/*.md
111+
- components/*/stories/*.mdx
112+
- plugins/*/*.md
113+
- tokens/*.md
114+
- tools/*/*.md
115+
- ui-icons/*.md
103116
plugins:
104117
- plugins/**/*
105118

‎.github/workflows/lint.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ on:
1818
eslint_modified_files:
1919
type: string
2020
required: false
21+
mdlint_added_files:
22+
type: string
23+
required: false
24+
mdlint_modified_files:
25+
type: string
26+
required: false
2127
workflow_call:
2228
inputs:
2329
styles_added_files:
@@ -32,6 +38,12 @@ on:
3238
eslint_modified_files:
3339
type: string
3440
required: false
41+
mdlint_added_files:
42+
type: string
43+
required: false
44+
mdlint_modified_files:
45+
type: string
46+
required: false
3547

3648
permissions:
3749
contents: read
@@ -104,3 +116,12 @@ jobs:
104116
filter_mode: diff_context
105117
# eslint_flags: "components/*/stories/*.js"
106118
eslint_flags: "${{ inputs.eslint_added_files }} ${{ inputs.eslint_modified_files }}"
119+
120+
- name: Run markdownlint on documentation
121+
uses: reviewdog/action-markdownlint@v1.0.0
122+
with:
123+
reporter: github-pr-review
124+
filter_mode: diff_context
125+
fail_level: error
126+
markdownlint_config: "${{ github.workspace }}/.markdownlint.json"
127+
markdownlint_input: "${{ inputs.mdlint_added_files }} ${{ inputs.mdlint_modified_files }}"

‎.markdownlint.json‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"extends": "markdownlint/style/prettier",
3+
"first-line-h1": false,
4+
"no-inline-html": false,
5+
"no-bare-urls": false,
6+
"no-duplicate-heading": {
7+
"siblings_only": true
8+
},
9+
"code-block-style": {
10+
"style": "fenced"
11+
},
12+
"code-fence-style": {
13+
"style": "backtick"
14+
},
15+
"emphasis-style": {
16+
"style": "underscore"
17+
},
18+
"strong-style": {
19+
"style": "asterisk"
20+
},
21+
"ul-style": {
22+
"style": "dash"
23+
}
24+
}

0 commit comments

Comments
 (0)