-
Notifications
You must be signed in to change notification settings - Fork 0
131 lines (108 loc) · 3.32 KB
/
checkers.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
name: "Check document files"
on:
push:
branches:
- main
pull_request:
branches:
- main
concurrency:
# If workflow is currently running, stop it and start a new one.
group: check-${{ github.ref }}
cancel-in-progress: true
permissions: read-all
jobs:
#---------------------------------------------------------------------
# 1-markdownlint
#---------------------------------------------------------------------
markdownlint:
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- id: changed
uses: tj-actions/changed-files@v45
with:
files: |
**.md
- name: Lint markdown files
if: steps.changed.outputs.any_changed == 'true'
uses: nosborn/[email protected]
with:
files: ${{ steps.changed.outputs.all_changed_files }}
config_file: .markdownlint.json
#---------------------------------------------------------------------
# 2-rstdoc8
#---------------------------------------------------------------------
rstdoc8:
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install doc8
run: |
pip3 install doc8
- id: changed
uses: tj-actions/changed-files@v45
with:
files: |
**.rst
- name: Lint restructured text files
if: steps.changed.outputs.any_changed == 'true'
run: |
doc8 --ignore D001 ${{ steps.changed.outputs.all_changed_files }}
#---------------------------------------------------------------------
# 3-rstcheck
#---------------------------------------------------------------------
rstcheck:
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install rstcheck
run: |
pip3 install rstcheck[sphinx]
- name: Get new and changed restructured text files
id: changed
uses: tj-actions/changed-files@v45
with:
files: |
**.rst
- name: Check restructured text files
if: steps.changed.outputs.any_changed == 'true'
run: |
rstcheck ${{ steps.changed.outputs.all_changed_files }}
#---------------------------------------------------------------------
# 4-sphinx-build
#---------------------------------------------------------------------
sphinx-build:
runs-on: ubuntu-latest
timeout-minutes: 10
permissions:
contents: write
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- uses: actions/checkout@v4
- name: pip install
run: |
sudo pip install sphinx sphinx_rtd_theme myst_parser
- id: pages
uses: actions/configure-pages@v5
- name: build sphinx document
run: |
sphinx-build -W docs/ _build
- name: deploy html to gh-pages branch
uses: peaceiris/actions-gh-pages@v4
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true