Skip to content

workflow_shared docs build push

briantist[bot] edited this page Jan 17, 2022 · 19 revisions

_shared-docs-build-push.yml

Ansible collection docs build (Push)

Jobs

ID Name Permissions
build-ansible-docs Build Ansible Docs
  • contents: read

Inputs

Name (✅required) Type Default Description
collection-name string ${{ github.event.repository.name }} The collection name in the form namespace.collection.
collection-path string This is the relative path component of the collection in question, for example community/general.
python string 3.9 The version of Python to install.
ansible-ref string milestone The ref from which to install ansible, for example "stable-2.12" or "milestone".
init-dest-dir string A directory relative to the checkout where the init process has already been run.
artifact-name string ${{ github.event.repository.name }}docs${{ github.sha }} The name of the artifact to upload.

Secrets

Name (✅required) Description

Outputs

Name Description
artifact-name The same artifact name as passed in, available as an output.
artifact-url The URL to the build artifacts.
Clone this wiki locally