workflow_shared docs build publish gh pages

_shared-docs-build-publish-gh-pages.yml

Ansible collection docs - publish to GitHub Pages

Jobs

ID	Name	Permissions
publish-gh-pages	Publish to GitHub Pages	contents: write pages: write id-token: write

---

Inputs

Name (✅required)	Type	Default	Description
artifact-name	string		The build artifact that contains the rendered HTML. Required when action == 'publish'
destination-dir	string		The destination path within the published site. Should not start with a forward slash '/'. If not given, the destination will be calculated based on what triggered the event: - pull - pr/<pr #> - push (branch) - branch/ - push (tag) - tag/
action	string	publish	Action to perform. 'publish' to publish the site, 'teardown' to tear it down.
base-url	string	https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}	The base URL of the published site. Do not include a trailing forward slash '/'. This is not used for the publishing process, but the resulting destination dir will be concatenated to it, and then returned in the workflow's outputs.
publish-gh-pages-branch	boolean	False	Whether to publish the gh-pages branch to GitHub Pages.

---

Secrets

Name (✅required)	Description
GH_TOKEN✅	The token used for publishing to GitHub Pages. Even when using the workflow token (secrets.GITHUB_TOKEN), it must be passed explicitly.

---

Outputs

Name	Description
url	The destination path pre-pended with the base-url.