mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 12:50:22 -07:00
Add role skeleton support (#17079)
* Add role skeleton support The default role skeleton used by ansible-galaxy is good, but it doesn't allow organizations to customize it to suit their needs. This patch addresses that by adding the option to point ansible-galaxy at a role skeleton directory. The contents of this directory are then copied (or rendered) into the output role directory. Appropriate command line options and configuration entries are added to allow for further customization from the role skeleton. * Remove dependency on platforms list from test Platforms are no longer provided to the template by galaxy init. Removing the code in our test meta/main.yml template that relied on it. * Fix whitespace issue
This commit is contained in:
parent
fffb4992b5
commit
bdf0ab451e
22 changed files with 353 additions and 3 deletions
29
test/units/cli/test_data/role_skeleton/.travis.yml
Normal file
29
test/units/cli/test_data/role_skeleton/.travis.yml
Normal file
|
@ -0,0 +1,29 @@
|
|||
---
|
||||
language: python
|
||||
python: "2.7"
|
||||
|
||||
# Use the new container infrastructure
|
||||
sudo: false
|
||||
|
||||
# Install ansible
|
||||
addons:
|
||||
apt:
|
||||
packages:
|
||||
- python-pip
|
||||
|
||||
install:
|
||||
# Install ansible
|
||||
- pip install ansible
|
||||
|
||||
# Check ansible version
|
||||
- ansible --version
|
||||
|
||||
# Create ansible.cfg with correct roles_path
|
||||
- printf '[defaults]\nroles_path=../' >ansible.cfg
|
||||
|
||||
script:
|
||||
# Basic role syntax check
|
||||
- ansible-playbook tests/test.yml -i tests/inventory --syntax-check
|
||||
|
||||
notifications:
|
||||
webhooks: https://galaxy.ansible.com/api/v1/notifications/
|
38
test/units/cli/test_data/role_skeleton/README.md
Normal file
38
test/units/cli/test_data/role_skeleton/README.md
Normal file
|
@ -0,0 +1,38 @@
|
|||
Role Name
|
||||
=========
|
||||
|
||||
A brief description of the role goes here.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
|
||||
|
||||
Role Variables
|
||||
--------------
|
||||
|
||||
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
|
||||
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
|
||||
|
||||
Example Playbook
|
||||
----------------
|
||||
|
||||
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
|
||||
|
||||
- hosts: servers
|
||||
roles:
|
||||
- { role: username.rolename, x: 42 }
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
BSD
|
||||
|
||||
Author Information
|
||||
------------------
|
||||
|
||||
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
|
|
@ -0,0 +1,2 @@
|
|||
---
|
||||
# defaults file for {{ role_name }}
|
0
test/units/cli/test_data/role_skeleton/files/.git_keep
Normal file
0
test/units/cli/test_data/role_skeleton/files/.git_keep
Normal file
|
@ -0,0 +1,2 @@
|
|||
---
|
||||
# handlers file for {{ role_name }}
|
1
test/units/cli/test_data/role_skeleton/inventory
Normal file
1
test/units/cli/test_data/role_skeleton/inventory
Normal file
|
@ -0,0 +1 @@
|
|||
localhost
|
59
test/units/cli/test_data/role_skeleton/meta/main.yml.j2
Normal file
59
test/units/cli/test_data/role_skeleton/meta/main.yml.j2
Normal file
|
@ -0,0 +1,59 @@
|
|||
galaxy_info:
|
||||
author: {{ author }}
|
||||
description: {{ description }}
|
||||
company: {{ company }}
|
||||
|
||||
# If the issue tracker for your role is not on github, uncomment the
|
||||
# next line and provide a value
|
||||
# issue_tracker_url: {{ issue_tracker_url }}
|
||||
|
||||
# Some suggested licenses:
|
||||
# - BSD (default)
|
||||
# - MIT
|
||||
# - GPLv2
|
||||
# - GPLv3
|
||||
# - Apache
|
||||
# - CC-BY
|
||||
license: {{ license }}
|
||||
|
||||
min_ansible_version: {{ min_ansible_version }}
|
||||
|
||||
# Optionally specify the branch Galaxy will use when accessing the GitHub
|
||||
# repo for this role. During role install, if no tags are available,
|
||||
# Galaxy will use this branch. During import Galaxy will access files on
|
||||
# this branch. If travis integration is cofigured, only notification for this
|
||||
# branch will be accepted. Otherwise, in all cases, the repo's default branch
|
||||
# (usually master) will be used.
|
||||
#github_branch:
|
||||
|
||||
#
|
||||
# platforms is a list of platforms, and each platform has a name and a list of versions.
|
||||
#
|
||||
# platforms:
|
||||
# - name: Fedora
|
||||
# versions:
|
||||
# - all
|
||||
# - 25
|
||||
# - name: SomePlatform
|
||||
# versions:
|
||||
# - all
|
||||
# - 1.0
|
||||
# - 7
|
||||
# - 99.99
|
||||
|
||||
galaxy_tags: []
|
||||
# List tags for your role here, one per line. A tag is
|
||||
# a keyword that describes and categorizes the role.
|
||||
# Users find roles by searching for tags. Be sure to
|
||||
# remove the '[]' above if you add tags to this list.
|
||||
#
|
||||
# NOTE: A tag is limited to a single word comprised of
|
||||
# alphanumeric characters. Maximum 20 tags per role.
|
||||
|
||||
dependencies: []
|
||||
# List your role dependencies here, one per line.
|
||||
# Be sure to remove the '[]' above if you add dependencies
|
||||
# to this list.
|
||||
{%- for dependency in dependencies %}
|
||||
#- {{ dependency }}
|
||||
{%- endfor %}
|
2
test/units/cli/test_data/role_skeleton/tasks/main.yml.j2
Normal file
2
test/units/cli/test_data/role_skeleton/tasks/main.yml.j2
Normal file
|
@ -0,0 +1,2 @@
|
|||
---
|
||||
# tasks file for {{ role_name }}
|
|
@ -0,0 +1,2 @@
|
|||
[defaults]
|
||||
test_key = {{ test_variable }}
|
|
@ -0,0 +1,2 @@
|
|||
[defaults]
|
||||
test_key = {{ test_variable }}
|
|
@ -0,0 +1 @@
|
|||
{{ role_name }}
|
5
test/units/cli/test_data/role_skeleton/tests/test.yml.j2
Normal file
5
test/units/cli/test_data/role_skeleton/tests/test.yml.j2
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
- hosts: localhost
|
||||
remote_user: root
|
||||
roles:
|
||||
- {{ role_name }}
|
2
test/units/cli/test_data/role_skeleton/vars/main.yml.j2
Normal file
2
test/units/cli/test_data/role_skeleton/vars/main.yml.j2
Normal file
|
@ -0,0 +1,2 @@
|
|||
---
|
||||
# vars file for {{ role_name }}
|
Loading…
Add table
Add a link
Reference in a new issue