skeleton-ansible-role

This is a skeleton project that can be used to quickly get a new cisagov Ansible role GitHub project started. This skeleton project contains licensing information, as well as pre-commit hooks and GitHub Actions configurations appropriate for an Ansible role.

Requirements

None.

Role Variables

None.

Dependencies

None.

Installation

This role can be installed via the command:

ansible-galaxy install --role-file path/to/requirements.yml

where requirements.yml looks like:

---
- name: skeleton
  src: https://github.com/cisagov/skeleton-ansible-role

and may contain other roles as well.

For more information about installing Ansible roles via a YAML file, please see the ansible-galaxy documentation.

Example Playbook

Here's how to use it in a playbook:

- hosts: all
  become: true
  become_method: sudo
  tasks:
    - name: Include skeleton
      ansible.builtin.include_role:
        name: skeleton

New Repositories from a Skeleton

Please see our Project Setup guide for step-by-step instructions on how to start a new repository from a skeleton. This will save you time and effort when configuring a new repository!

Contributing

We welcome contributions! Please see CONTRIBUTING.md for details.

License

This project is in the worldwide public domain.

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

Author Information

First Last - [email protected]