Skip to content

Commit 64e9f60

Browse files
castastrophecastastrophe
committed
build: add markdownlint tooling
1 parent 978f549 commit 64e9f60

File tree

105 files changed

+8194
-34002
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

+8194
-34002
lines changed

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

Lines changed: 30 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -10,77 +10,67 @@
1010

1111
### Minor Changes
1212

13-
- [#3488](https://github.com/adobe/spectrum-css/pull/3488) [`40c1954`](https://github.com/adobe/spectrum-css/commit/40c1954048f735a07f9edfccf3a568d38164806a) Thanks [@castastrophe](https://github.com/castastrophe)! - 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.
13+
- [#3488](https://github.com/adobe/spectrum-css/pull/3488) [`40c1954`](https://github.com/adobe/spectrum-css/commit/40c1954048f735a07f9edfccf3a568d38164806a) Thanks [@castastrophe](https://github.com/castastrophe)!
14+
15+
- 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.
1416

1517
## 2.0.6
1618

1719
### Patch Changes
1820

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

21-
All notable changes to this project will be documented in this file.
22-
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
25+
## 2.0.5
2326

24-
<a name="2.0.5"></a>
25-
##2.0.5
26-
🗓
27-
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)
27+
🗓 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)
2828

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

31-
<a name="2.0.4"></a>
32-
##2.0.4
33-
🗓
34-
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)
31+
## 2.0.4
32+
33+
🗓 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)
3534

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

38-
<a name="2.0.3"></a>
39-
##2.0.3
40-
🗓
41-
2024-02-06
37+
## 2.0.3
38+
39+
🗓 2024-02-06
4240

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

45-
<a name="2.0.2"></a>
46-
##2.0.2
47-
🗓
48-
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)
43+
## 2.0.2
44+
45+
🗓 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)
4946

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

52-
<a name="2.0.1"></a>
53-
##2.0.1
54-
🗓
55-
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)
49+
## 2.0.1
50+
51+
🗓 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)
5652

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

59-
<a name="2.0.0"></a>
6055
#2.0.0
61-
🗓
62-
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)
56+
🗓 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)
6357

64-
\*feat(icon,ui-icons)!: migrate the icon compiler to a distinct package (#2343)([d73d594](https://github.com/adobe/spectrum-css/commit/d73d594)), closes[#2343](https://github.com/adobe/spectrum-css/issues/2343)
58+
- feat(icon,ui-icons)!: migrate the icon compiler to a distinct package (#2343)([d73d594](https://github.com/adobe/spectrum-css/commit/d73d594)), closes[#2343](https://github.com/adobe/spectrum-css/issues/2343)
6559

66-
###
67-
🛑 BREAKING CHANGES
60+
### 🛑 BREAKING CHANGES
6861

69-
*
70-
- @spectrum-css/icon will no longer contain SVG assets; it will be a purely CSS package with all SVG assets migrated to the new @spectrum-css/ui-icons package.
62+
- @spectrum-css/icon will no longer contain SVG assets; it will be a purely CSS package with all SVG assets migrated to the new @spectrum-css/ui-icons package.
7163

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

74-
<a name="1.0.2"></a>
75-
##1.0.2
76-
🗓
77-
2023-11-15
66+
## 1.0.2
67+
68+
🗓 2023-11-15
7869

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

81-
<a name="1.0.1"></a>
82-
##1.0.1
83-
🗓
84-
2023-11-13
72+
## 1.0.1
73+
74+
🗓 2023-11-13
8575

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

‎.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)