Skip to content

Commit

Permalink
Merge pull request #2 from evalero/feat/create-readme
Browse files Browse the repository at this point in the history
Added meta information
  • Loading branch information
Ernesto authored Mar 29, 2018
2 parents 98a5f27 + 96ea8ee commit 187c15a
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 81 deletions.
43 changes: 11 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,27 @@
Role Name
Atom
=========

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.
A role to install [Atom ide](https://atom.io)

Role Variables
--------------
* ` gpg_key ` : url to gpg key
* ` atom_repo `: Depending on OS family, change the atom_repo var to point to correct version.

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: atom, x: 42 }

```
- hosts: localhost
roles:
- atom
```
License
-------

BSD
GPLv2

Author Information
------------------

An optional section for the role authors to include contact information, or a
website (HTML is not allowed).
Ernesto Valero ([email protected])
65 changes: 16 additions & 49 deletions meta/main.yml
Original file line number Diff line number Diff line change
@@ -1,58 +1,25 @@
---
galaxy_info:
author: your name
description: your description
company: your company (optional)
author: Ernesto Valero ([email protected])
description: Install Atom ide
company: Paradigma Digital

# If the issue tracker for your role is not on github, uncomment the
# next line and provide a value
# issue_tracker_url: http://example.com/issue/tracker
license: license GPLv2

# Some suggested licenses:
# - BSD (default)
# - MIT
# - GPLv2
# - GPLv3
# - Apache
# - CC-BY
license: license (GPLv2, CC-BY, etc)
min_ansible_version: 2.2

min_ansible_version: 1.2
platforms:
- name: CentOS
versions:
- 7
- name: Ubuntu
versions:
- xenial
- name: Debian
version:
- stretch

# If this a Container Enabled role, provide the minimum Ansible Container version.
# min_ansible_container_version:
galaxy_tags: [IDE, atom]

# 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 configured, only notifications 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.

0 comments on commit 187c15a

Please sign in to comment.