action_ansible docs build html

ansible-docs-build-html

Invoke an Ansible docs build

Builds the docs. Requires initialized build environment.

Inputs

Name (✅required)	Default	Description
build-script	${{ runner.temp }}/docsbuild/build.sh	The path to the build script.
build-html	${{ runner.temp }}/docsbuild/build/html	The path where the build script will output the HTML.
copy-build		If set, copy the built HTML files to this path after building, and set the build-html output to this path instead. This is useful if you need to do multiple builds from the same environment, or otherwise need the files to be elsewhere. Note: files in the destination that do not exist in the source will be deleted!
artifact-upload	true	If true then upload the rendered docs as a build artifact.
artifact-name	${{ github.event.repository.name }}_docs	The name of the build artifact.
artifact-retention-days	7	Number of days to keep the artifact.

---

Outputs

Name	Description
hash	The hash of the generated docs. This will be empty unless the build-html path is within the Workspace.
artifact-url	The URL to the artifact.
artifact-name	The name of the uploaded artifact.
build-html	The end location of the built HTML files.