-
Notifications
You must be signed in to change notification settings - Fork 0
166 lines (145 loc) · 4.7 KB
/
workflow_docs.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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
name: GH Workflow Docs
on:
push:
branches: [main]
jobs:
gen_workflow_docs:
name: Auto Doc
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Document doxygen_build
uses: tj-actions/auto-doc@v3
with:
reusable: true
filename: .github/workflows/doxygen_build.yml
output: docs/doxygen_build.md
- name: Document env_vars
uses: tj-actions/auto-doc@v3
with:
reusable: true
filename: .github/workflows/env_vars.yml
output: docs/env_vars.md
- name: Document image_build
uses: tj-actions/auto-doc@v3
with:
reusable: true
filename: .github/workflows/image_build.yml
output: docs/image_build.md
- name: Document image_build_multi
uses: tj-actions/auto-doc@v3
with:
reusable: true
filename: .github/workflows/image_build_multi.yml
output: docs/image_build_multi.md
- name: Document image_artifact
uses: tj-actions/auto-doc@v3
with:
reusable: true
filename: .github/workflows/image_artifact.yml
output: docs/image_artifact.md
- name: Document mkdocs_build
uses: tj-actions/auto-doc@v3
with:
reusable: true
filename: .github/workflows/mkdocs_build.yml
output: docs/mkdocs_build.md
- name: Document npm_publish
uses: tj-actions/auto-doc@v3
with:
reusable: true
filename: .github/workflows/npm_publish.yml
output: docs/npm_publish.md
- name: Document openapi_build
uses: tj-actions/auto-doc@v3
with:
reusable: true
filename: .github/workflows/openapi_build.yml
output: docs/openapi_build.md
- name: Document py_app_version
uses: tj-actions/auto-doc@v3
with:
reusable: true
filename: .github/workflows/py_app_version.yml
output: docs/py_app_version.md
- name: Document pypi_publish
uses: tj-actions/auto-doc@v3
with:
reusable: true
filename: .github/workflows/pypi_publish.yml
output: docs/pypi_publish.md
- name: Document remote_deploy
uses: tj-actions/auto-doc@v3
with:
reusable: true
filename: .github/workflows/remote_deploy.yml
output: docs/remote_deploy.md
- name: Document stories_build
uses: tj-actions/auto-doc@v3
with:
reusable: true
filename: .github/workflows/stories_build.yml
output: docs/stories_build.md
- name: Document test_pnpm
uses: tj-actions/auto-doc@v3
with:
reusable: true
filename: .github/workflows/test_pnpm.yml
output: docs/test_pnpm.md
- name: Document test_compose
uses: tj-actions/auto-doc@v3
with:
reusable: true
filename: .github/workflows/test_compose.yml
output: docs/test_compose.md
- name: Document test_pytest
uses: tj-actions/auto-doc@v3
with:
reusable: true
filename: .github/workflows/test_pytest.yml
output: docs/test_pytest.md
- name: Document wiki
uses: tj-actions/auto-doc@v3
with:
reusable: true
filename: .github/workflows/wiki.yml
output: docs/wiki.md
- name: Run pre-commit hooks
run: |
pip install pre-commit
# Don't send exit code
pre-commit run --all-files || true
- name: Verify Changed Files
uses: tj-actions/[email protected]
id: verify-changed-files
with:
files: |
docs/index.md
docs/intro.md
docs/doxygen_build.md
docs/env_vars.md
docs/image_artifact.md
docs/image_build.md
docs/image_build_multi.md
docs/mkdocs_build.md
docs/npm_publish.md
docs/openapi_build.md
docs/py_app_version.md
docs/pypi_publish.md
docs/remote_deploy.md
docs/stories_build.md
docs/test_pnpm.md
docs/test_compose.md
docs/test_pytest.md
docs/wiki.md
- name: Create Pull Request
if: steps.verify-changed-files.outputs.files_changed == 'true'
uses: peter-evans/create-pull-request@v3
with:
base: "main"
title: "auto-doc: updated workflows docs"
branch: "docs/auto-doc-update-workflows"
commit-message: "docs: updated workflow docs"
body: "PR triggered via workflow_docs.yml workflow."