Skip to content

Commit e845960

Browse files
authored
Merge pull request #10 from o-l-a-v/chore/tools-update
chore: move config to .config/, change md linter to rumdl, update wor…
2 parents ed38f17 + de5fdd8 commit e845960

15 files changed

Lines changed: 81 additions & 77 deletions

.config/rumdl.toml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# rumdl configuration
2+
# Schema: https://raw.githubusercontent.com/rvben/rumdl/main/rumdl.schema.json
3+
4+
[global]
5+
disable = ["MD013", "MD025", "MD041"]
6+
7+
# MD003 / heading-style - Heading style should be consistent
8+
[MD003]
9+
style = "atx"
10+
11+
# MD004 / ul-style - Unordered list style should be consistent
12+
[MD004]
13+
style = "asterisk"
14+
15+
# MD029 / ol-prefix - Use consistent numbers for ordered lists
16+
[MD029]
17+
style = "one-or-ordered"
18+
19+
# MD033 / no-inline-html - No HTML tags
20+
[MD033]
21+
allowed-elements = ["details", "summary"]
22+
23+
# MD040 / fenced-code-language - Code blocks should have a language specified
24+
[MD040]
25+
style = "disabled"
26+
27+
# MD055 / table-pipe-style - Keep table formatting consistent
28+
[MD055]
29+
style = "leading-and-trailing"
30+
31+
# MD060 / table-format - Table Format
32+
[MD060]
33+
enabled = true
34+
style = "aligned"
File renamed without changes.

.github/workflows/pr-any-dependency-review.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ on:
77

88
jobs:
99
dependency-review:
10-
runs-on: ubuntu-latest
10+
runs-on: ubuntu-slim
1111
permissions:
1212
contents: read
1313
steps:
1414
- name: 🛎️ GitHub checkout branch "${{ github.head_ref || github.ref_name }}"
15-
uses: actions/checkout@v5
15+
uses: actions/checkout@v6
1616
with:
1717
persist-credentials: false
1818
- name: 🔬 Dependency review

.github/workflows/pr-any-ensure-editorconfig.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Ensure changed files follows EditorConfig settings
1+
name: Ensure changed files follow EditorConfig settings
22

33
run-name: "${{ github.workflow }} - [${{ github.event.pull_request.title }} #${{ github.event.pull_request.number }}] by @${{ github.actor }}"
44

@@ -25,10 +25,10 @@ jobs:
2525
permissions:
2626
contents: read
2727
pull-requests: read
28-
runs-on: ubuntu-latest
28+
runs-on: ubuntu-slim
2929
steps:
3030
- name: 🛎️ GitHub checkout branch "${{ github.head_ref || github.ref_name }}"
31-
uses: actions/checkout@v5
31+
uses: actions/checkout@v6
3232
with:
3333
persist-credentials: false
3434
- name: 🔍 Get changed files
@@ -58,7 +58,7 @@ jobs:
5858
- name: 🪲 Debug
5959
run: echo ${{ needs.changes.outputs.files }}
6060
- name: 🛎️ GitHub checkout branch "${{ github.head_ref || github.ref_name }}"
61-
uses: actions/checkout@v5
61+
uses: actions/checkout@v6
6262
with:
6363
persist-credentials: false
6464
- name: ⬇️ Install EditorConfig-Checker
Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
1-
name: Lint Markdown with mardownlint-cli2
1+
name: Lint markdown with rumdl
22

33
run-name: "${{ github.workflow }} - [${{ github.event.pull_request.title }} #${{ github.event.pull_request.number }}] by @${{ github.actor }}"
44

55
on:
66
pull_request:
77
paths:
88
- "**.md"
9+
- "**/*rumdl.toml"
910

1011
concurrency:
1112
group: ${{ github.workflow }}-${{ github.ref }}
1213
cancel-in-progress: true
1314

1415
jobs:
1516
lint-markdown:
16-
name: Run markdownlint-cli2
17+
name: Run rumdl
1718
permissions:
1819
contents: read
1920
pull-requests: read
20-
runs-on: ubuntu-latest
21+
runs-on: ubuntu-slim
2122
steps:
2223
- name: 🛎️ GitHub checkout branch "${{ github.head_ref || github.ref_name }}"
23-
uses: actions/checkout@v5
24+
uses: actions/checkout@v6
2425
with:
2526
persist-credentials: false
2627
- name: 🔍 Get changed files
@@ -30,9 +31,21 @@ jobs:
3031
filters: |
3132
markdown:
3233
- added|modified: '**.md'
34+
rumdlconf:
35+
- added|modified: '{.,}rumdl.toml'
36+
- added|modified: '.config/{.,}rumdl.toml'
3337
list-files: escape
34-
- name: 🔍 Lint with markdownlint-cli2
35-
if: steps.filter.outputs.markdown == 'true'
36-
uses: DavidAnson/markdownlint-cli2-action@992badcdf24e3b8eb7e87ff9287fe931bcb00c6e # v20.0.0
38+
- name: ⬇️ Install the latest version of uv
39+
if: steps.filter.outputs.markdown == 'true' || steps.filter.outputs.rumdlconf == 'true'
40+
uses: astral-sh/setup-uv@eac588ad8def6316056a12d4907a9d4d84ff7a3b # v7.3.0
3741
with:
38-
globs: ${{ steps.filter.outputs.markdown_files }}
42+
cache-dependency-glob: ""
43+
enable-cache: true
44+
- name: 🔍 Lint changed markdown files with rumdl
45+
if: steps.filter.outputs.markdown == 'true' && steps.filter.outputs.rumdlconf == 'false'
46+
shell: bash
47+
run: uvx rumdl check ${{ steps.filter.outputs.markdown_files }}
48+
- name: 🔍 Lint all markdown files with rumdl when ".rumdl.toml" is updated
49+
if: steps.filter.outputs.rumdlconf == 'true'
50+
shell: bash
51+
run: uvx rumdl check .

.github/workflows/pr-any-lint-powershell.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
runs-on: ubuntu-latest
2121
steps:
2222
- name: 🛎️ GitHub checkout branch "${{ github.head_ref || github.ref_name }}"
23-
uses: actions/checkout@v5
23+
uses: actions/checkout@v6
2424
with:
2525
persist-credentials: false
2626
- name: 🔍 Get changed files

.github/workflows/pr-any-lint-workflows.yaml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ jobs:
1717
permissions:
1818
contents: read
1919
pull-requests: read
20-
runs-on: ubuntu-latest
20+
runs-on: ubuntu-slim
2121
steps:
2222
- name: 🛎️ GitHub checkout branch "${{ github.head_ref || github.ref_name }}"
23-
uses: actions/checkout@v5
23+
uses: actions/checkout@v6
2424
with:
2525
persist-credentials: false
2626
- name: 🔍 Get changed files
@@ -33,9 +33,13 @@ jobs:
3333
list-files: escape
3434
- name: ⬇️ Install the latest version of uv
3535
if: steps.filter.outputs.workflows == 'true'
36-
uses: astral-sh/setup-uv@557e51de59eb14aaaba2ed9621916900a91d50c6 # v6.6.0
36+
uses: astral-sh/setup-uv@eac588ad8def6316056a12d4907a9d4d84ff7a3b # v7.3.0
37+
with:
38+
cache-dependency-glob: ""
39+
enable-cache: true
3740
- name: 🔍 Run zizmor
3841
if: steps.filter.outputs.workflows == 'true'
3942
run: |
4043
uvx zizmor --format plain --offline --min-confidence low --min-severity low \
44+
--config ./.config/zizmor.yml \
4145
${{ steps.filter.outputs.workflows_files }}

.markdownlint.jsonc

Lines changed: 0 additions & 39 deletions
This file was deleted.

.vscode/extensions.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
{
22
"recommendations": [
3-
"DavidAnson.vscode-markdownlint",
43
"EditorConfig.EditorConfig",
5-
"Jota0222.multi-formatter",
64
"ms-vscode.powershell",
7-
"yzhang.markdown-all-in-one"
5+
"rvben.rumdl"
86
]
97
}

0 commit comments

Comments
 (0)