Playwright

Simple utility that helps you manage Ansible roles folder structure.

Why

Ansible is shipped with a tool for creation of folder structure for new roles. It creates full structure of folders and main.yml files. Generally you don’t need to create all that folders and most frequent case is having tasks folder and main.yml there. Also, unused folders and files produce same effect as dead code in any codebase.

Playwright allows you to control which parts of the role you create and when.

How to use it

Basic usage

You need to set up path to your ansible.cfg file. By default playwright will expect to find it in:

• ANSIBLE_CONFIG environment variable
• in the current directory by name ansible.cfg or .ansible.cfg
• in your system config folder /etc/ansible/ansible.cfg

You need to set up path to the roles folder in your ansible.cfg:

roles_path=/somewhere/in/my/system

Now you can call playwright to build folder structure:

playwright [<flags>] <command> [<args> ...]

Flags:
  --help       Show context-sensitive help (also try --help-long and --help-man).
  --version    Show application version.
  --handlers   Add 'handlers' folder
  --templates  Add 'templates' folder
  --files      Add 'files' folder
  --vars       Add 'vars' folder
  --defaults   Add 'defaults' folder
  --meta       Add 'meta' folder
  --all        Apply action to all folders
  --no-color   Disable color output

Commands:
  help [<command>...]
	Show help.

  create <name>
	Creates a playbook

  update <name>
	Updates a playbook

  delete <name>
	Deletes a playbook

By default, playwright creates only tasks folder and main.yml in it.

Disabling colors in output

Colored output can be disabled using multiple methods:

• using --no-color flag for the command
• using PLAYWRIGHT_NOCOLOR=true environment variable
• using NO_COLOR=true system wide environment variable
• using TERM=dumb environment variable

Building and installing

To build playwright you need

• GoLang installed and $GOPATH set
• dep to install dependencies

To build and install run next command:

sudo make install

Binary file will be copied to your /usr/local/bin directory.

To simply build binary, run:

make build

Changelog

Check CHANGELOG file.

Contributing

If you’re interested in contributing to this project, first of all I would like to extend my heartfelt gratitude.

Check CONTRIBUTING for more details, please.

License

This software is built and distributed under GPLv3 license (Ansible uses this license). For more information check LICENSE file in the root folder of the repository.