Skip to content

Commit 6df7dac

Browse files
committed
[workflow] Check scdoc pages
Signed-off-by: Shinyzenith <[email protected]>
1 parent 7fee8db commit 6df7dac

File tree

1 file changed

+42
-30
lines changed

1 file changed

+42
-30
lines changed

.github/workflows/ci.yml

+42-30
Original file line numberDiff line numberDiff line change
@@ -3,46 +3,58 @@ name: CI
33
on: [push, pull_request]
44

55
env:
6-
CARGO_TERM_COLOR: always
6+
CARGO_TERM_COLOR: always
77

88
jobs:
9-
build:
10-
runs-on: ubuntu-latest
9+
build:
10+
runs-on: ubuntu-latest
1111

12-
steps:
13-
- name: Checkout
14-
uses: actions/checkout@v2
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v2
1515

16-
- name: Build
17-
run: cargo build --release
16+
- name: Build
17+
run: cargo build --release
1818

19-
clippy:
20-
runs-on: ubuntu-latest
19+
clippy:
20+
runs-on: ubuntu-latest
2121

22-
steps:
23-
- name: Checkout
24-
uses: actions/checkout@v2
22+
steps:
23+
- name: Checkout
24+
uses: actions/checkout@v2
2525

26-
- name: Clippy
27-
run: cargo clippy
26+
- name: Clippy
27+
run: cargo clippy
2828

29-
test:
30-
runs-on: ubuntu-latest
29+
test:
30+
runs-on: ubuntu-latest
3131

32-
steps:
33-
- name: Checkout
34-
uses: actions/checkout@v2
32+
steps:
33+
- name: Checkout
34+
uses: actions/checkout@v2
3535

36-
- name: Run tests
37-
run: cargo test --verbose
36+
- name: Run tests
37+
run: cargo test --verbose
3838

39-
rustfmt:
40-
runs-on: ubuntu-latest
39+
documentation:
40+
runs-on: ubuntu-latest
4141

42-
steps:
43-
- name: Checkout
44-
uses: actions/checkout@v2
42+
steps:
43+
- name: Checkout
44+
uses: actions/checkout@v2
4545

46-
- name: Check formatting
47-
run: |
48-
cargo fmt -- --check
46+
- name: Check documentation
47+
run: |
48+
sudo apt update
49+
sudo apt install --no-install-recommends scdoc
50+
for file in $(find . -type f -iname "*.scd"); do scdoc < $file > /dev/null; done
51+
rustfmt:
52+
runs-on: ubuntu-latest
53+
54+
steps:
55+
- name: Checkout
56+
uses: actions/checkout@v2
57+
58+
- name: Check formatting
59+
run: |
60+
cargo fmt -- --check

0 commit comments

Comments
 (0)