https://github.com/dawidd6/action-ansible-playbook

:gear: A GitHub Action for running Ansible playbooks
https://github.com/dawidd6/action-ansible-playbook

action ansible ansible-playbook github github-actions playbook run ssh

Last synced: 1 day ago
JSON representation

:gear: A GitHub Action for running Ansible playbooks

• Host: GitHub
• URL: https://github.com/dawidd6/action-ansible-playbook
• Owner: dawidd6
• License: mit
• Created: 2020-03-21T15:36:22.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-12-31T07:55:39.000Z (12 days ago)
• Last Synced: 2025-01-03T23:04:29.262Z (8 days ago)
• Topics: action, ansible, ansible-playbook, github, github-actions, playbook, run, ssh
• Language: JavaScript
• Homepage:
• Size: 980 KB
• Stars: 311
• Watchers: 5
• Forks: 68
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - dawidd6/action-ansible-playbook - :gear: A GitHub Action for running Ansible playbooks (ansible)

README

        
# Run Ansible playbook GitHub Action

An Action that executes given Ansible playbook on selected hosts.

Should work on any OS, if `ansible-playbook` command is available in `PATH`.

## Usage

```yaml

- name: Run playbook

  uses: dawidd6/action-ansible-playbook@v2

  with:

    # Required, playbook filepath

    playbook: deploy.yml

    # Optional, directory where playbooks live

    directory: ./

    # Optional, ansible configuration file content (ansible.cfg)

    configuration: |

      [defaults]

      callbacks_enabled = ansible.posix.profile_tasks, ansible.posix.timer

      stdout_callback = yaml

      nocows = false

    # Optional, SSH private key

    key: ${{secrets.SSH_PRIVATE_KEY}}

    # Optional, literal inventory file contents

    inventory: |

      [all]

      example.com

      [group1]

      example.com

    # Optional, SSH known hosts file content

    known_hosts: |

      example.com ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl

    # Optional, encrypted vault password

    vault_password: ${{secrets.VAULT_PASSWORD}}

    # Optional, galaxy requirements filepath

    requirements: galaxy-requirements.yml

    # Optional, additional flags to pass to ansible-playbook

    options: |

      --inventory .hosts

      --limit group1

      --extra-vars hello=there

      --verbose

```