andreagiulianelli/Documentation GH-Pages Action

Generate the code, asyncapi and openapi documentation and push it on Github Pages.

Trust Signals

name	description	required	default
should-generate-code-documentation	True if you want to generate the code documentation, false otherwise.	no	false
code-documentation-generation-command	The command to generate code documentation.	no	./gradlew dokkaHtml
code-documentation-dst-folder	The destination folder of the generated code documentation.	no	./build/dokka/html
code-documentation-site-folder	The site folder of the generated code documentation.	no	documentation/code-doc/
should-generate-openapi-documentation	True if you want to generate the open api documentation, false otherwise.	no	false
openapi-documentation-input-file	The input file with rest api specification in open api standard.	no	docs/openapi/openapi.yml
openapi-documentation-dst-folder	The destination folder of the generated open api documentation.	no	documentation/openapi-doc
should-generate-asyncapi-documentation	True if you want to generate the async api documentation, false otherwise.	no	false
asyncapi-documentation-input-file	The input file with async api specification in latest async api standard.	no	docs/asyncapi/asyncapi.yml
asyncapi-documentation-dst-folder	The destination folder of the generated async api documentation.	no	documentation/asyncapi-doc
github-token	The GitHub token, it will be used to push the documentation on gh-pages branch	yes	—

no outputs