Skip to content

Commit 5e1fb6f

Browse files
committed
ci: Enable mdformat check action
Add mdformat.yaml to check markdown style in repository. Signed-off-by: Ruoqing He <[email protected]>
1 parent 2fa70d2 commit 5e1fb6f

File tree

3 files changed

+29
-5
lines changed

3 files changed

+29
-5
lines changed

Diff for: .github/workflows/mdformat.yaml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Markdown style check
2+
on:
3+
pull_request:
4+
merge_group:
5+
push:
6+
branches:
7+
- main
8+
9+
jobs:
10+
md-style-checker:
11+
name: Check Markdown Style
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout repository
15+
uses: actions/checkout@v4
16+
17+
- name: Install mdformat
18+
run: |
19+
sudo apt update
20+
sudo apt install python3 python3-pip pipx
21+
pipx install mdformat
22+
pipx inject mdformat mdformat-gfm mdformat-frontmatter mdformat-footnote mdformat-gfm-alerts
23+
24+
- name: Check Content Style
25+
run: |
26+
mdformat --check .

Diff for: src/SUMMARY.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
# How to Manage Mono-repo
44

5-
- [Firecraker]()
6-
- [Markdown Files](repo-management/firecracker/markdown.md)
7-
- [Rust Files](repo-management/firecracker/rustfmt.md)
5+
- [Firecraker](<>)
6+
- [Markdown Files](repo-management/firecracker/markdown.md)
7+
- [Rust Files](repo-management/firecracker/rustfmt.md)

Diff for: src/research/pvm/requirements.md

-2
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,3 @@ cloud. State-of-the-art nested virtualization in the x86 architecture relies
1010
heavily on the host hypervisor to expose hardware virtualization support to the
1111
guest hypervisor, not only complicating cloud management but also raising
1212
concerns about an increased attack surface at the host hypervisor.
13-
14-

0 commit comments

Comments
 (0)