Skip to content

Commit fbeb142

Browse files
chore: add action input
1 parent 8b0550e commit fbeb142

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

action.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Documentation GH-Pages Action
2+
description: Generate the code, asyncapi and openapi documentation and push it on Github Pages.
3+
4+
inputs:
5+
6+
should-generate-code-documentation:
7+
description: 'True if you want to generate the code documentation, false otherwise.'
8+
type: boolean
9+
default: 'false'
10+
required: false
11+
12+
code-documentation-generation-command:
13+
description: 'The command to generate code documentation.'
14+
default: './gradlew dokkaHtml'
15+
required: false
16+
17+
code-documentation-dst-folder:
18+
description: 'The destination folder of the generated code documentation.'
19+
default: 'build/code-doc/'
20+
required: false
21+
22+
should-generate-openapi-documentation:
23+
description: 'True if you want to generate the open api documentation, false otherwise.'
24+
default: 'false'
25+
required: false
26+
27+
openapi-documentation-input-file:
28+
description: 'The input file with rest api specification in open api standard.'
29+
default: 'docs/openapi/openapi.yml'
30+
required: false
31+
32+
openapi-documentation-dst-folder:
33+
description: 'The destination folder of the generated open api documentation.'
34+
default: 'build/openapi-doc/'
35+
required: false
36+
37+
should-generate-asyncapi-documentation:
38+
description: 'True if you want to generate the async api documentation, false otherwise.'
39+
default: 'false'
40+
required: false
41+
42+
asyncapi-documentation-input-file:
43+
description: 'The input file with async api specification in latest async api standard.'
44+
default: 'docs/asyncapi/asyncapi.yml'
45+
required: false
46+
47+
async-documentation-dst-folder:
48+
description: 'The destination folder of the generated async api documentation.'
49+
default: 'build/asyncapi-doc/'
50+
required: false
51+
52+

0 commit comments

Comments
 (0)