vatsaljagani/ansible-action

GitHub Action for Ansible Install, Upgrade, Playbook Run and more

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
execution_modeExecution mode (install_or_upgrade_ansible, run_playbook, run_ad_hoc_command)norun_playbook
working_directoryWorking directory inside automation repono.
ansible_versionAnsible package version selector (latest or explicit version)nolatest
ansible_install_typeAnsible package to install (core or full)nocore
python_versionPython version used by setup-pythonno3.11
automation_repoOwner/repo containing Ansible roles and playbooks (defaults to current workflow repository when omitted)no""
automation_refGit ref for automation repo (defaults to current workflow ref when omitted)no""
automation_tokenToken for automation repo checkout; when automation_repo defaults to current workflow repository, pass an explicit token (for example secrets.GITHUB_TOKEN)no
inventory_repoOwner/repo containing inventory and environment vars (defaults to current workflow repository when omitted)no""
inventory_refGit ref for inventory repo (defaults to current workflow ref when omitted)no""
inventory_tokenToken for inventory repo checkout; when inventory_repo defaults to current workflow repository, pass an explicit token (for example secrets.GITHUB_TOKEN)no
playbook_pathPlaybook path inside automation repo (required for execution_mode=run_playbook)no
inventory_pathInventory path inside inventory repo (required for run_playbook and run_ad_hoc_command)no
host_patternHost targeting pattern (`-l` for playbook mode; positional host pattern for ad-hoc mode)no
ad_hoc_moduleAnsible ad-hoc module name for command mode (default shell)no
ad_hoc_module_argsModule arguments for ad-hoc command mode (for example uname -a)no
check_modeRun ansible in check modenofalse
enforce_check_mode_on_prFail PR run if check_mode is falsenotrue
tagsComma-separated ansible tagsno
skip_tagsComma-separated ansible skip-tagsno
verbosityVerbosity level 0..4no0
extra_varsExtra vars YAML/JSON or key=value listno
extra_vars_fileExtra vars file path in inventory repono
diff_modeRun ansible with --diffnofalse
becomeRun tasks with privilege escalation (--become)nofalse
become_userUser to become with --become-userno
forksNumber of parallel forks (--forks)no5
timeoutSSH timeout in seconds (--timeout)no10
start_at_taskStart execution at specific task name (--start-at-task)no
ansible_config_pathOptional ANSIBLE_CONFIG path for runtimeno
vault_password_secret_envEnv var name that contains ansible vault passwordno
github_tokenOptional generic token; defaults to GITHUB_TOKENno
ca_bundle_pathOptional CA bundle path for enterprise TLSno
artifact_nameName for uploaded action artifactsnoansible-run-artifacts
namedescription
statussuccess or failure
exit_codeansible-playbook process exit code
changedchanged total from play recap
failedfailed total from play recap
unreachableunreachable total from play recap
okok total from play recap
skippedskipped total from play recap
rescuedrescued total from play recap
ignoredignored total from play recap
play_recap_jsonpath to recap json file
summary_pathpath to markdown summary file
log_pathpath to raw ansible log
automation_repo_resolved_refresolved automation commit sha
inventory_repo_resolved_refresolved inventory commit sha
automation_fetch_attemptstotal git command attempts used to fetch automation repository
automation_fetch_retriestotal retries consumed during automation repository fetch
automation_fetch_elapsed_mselapsed milliseconds spent fetching automation repository
inventory_fetch_attemptstotal git command attempts used to fetch inventory repository
inventory_fetch_retriestotal retries consumed during inventory repository fetch
inventory_fetch_elapsed_mselapsed milliseconds spent fetching inventory repository
failure_categoryclassified failure category (none on success)
failure_reasonfailure reason summary
failure_hintremediation hint for failures
first_failed_taskfirst failed ansible task when detectable