From 38442259c3b2309864a4f2bc774831df42f72e4c Mon Sep 17 00:00:00 2001 From: Alex Schultz Date: Mon, 30 Jul 2018 14:31:45 -0600 Subject: [PATCH] Switch README to RST and add lint The default readme had an issue when publishing to pypi, so let's clean up the readme and add it to the linters so we won't have to clean it up later. Change-Id: I3c9ef884f166fe6714ac297a20add2259f1f9f46 --- .../.gitignore | 71 +++++++++++++++++++ .../README.md | 29 -------- .../README.rst | 44 ++++++++++++ .../defaults/main.yml | 1 + .../setup.cfg | 2 +- .../test-requirements.txt | 1 + .../tox.ini | 2 + 7 files changed, 120 insertions(+), 30 deletions(-) create mode 100644 ansible-role-tripleo-{{cookiecutter.project_name}}/.gitignore delete mode 100644 ansible-role-tripleo-{{cookiecutter.project_name}}/README.md create mode 100644 ansible-role-tripleo-{{cookiecutter.project_name}}/README.rst diff --git a/ansible-role-tripleo-{{cookiecutter.project_name}}/.gitignore b/ansible-role-tripleo-{{cookiecutter.project_name}}/.gitignore new file mode 100644 index 0000000..83d9e09 --- /dev/null +++ b/ansible-role-tripleo-{{cookiecutter.project_name}}/.gitignore @@ -0,0 +1,71 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +sdist/ +var/ +container_registry.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*,cover + +# Translations +*.mo +*.pot + +# Django stuff: +*.log + +# Sphinx documentation +doc/build/ + +# PyBuilder +target/ + +# virtualenv +.venv/ + +# jenkins config +jenkins/config.ini +playbooks/debug.yml + +# Files created by releasenotes build +releasenotes/build + +# Editors +.*.sw[klmnop] + +# ansible retry files +*.retry diff --git a/ansible-role-tripleo-{{cookiecutter.project_name}}/README.md b/ansible-role-tripleo-{{cookiecutter.project_name}}/README.md deleted file mode 100644 index d57e584..0000000 --- a/ansible-role-tripleo-{{cookiecutter.project_name}}/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# TripleO {{ cookiecutter.project_name }}# - -A role to manage {{ cookiecutter.project_name }} tasks for TripleO - -## Role Variables ## - -**Variables used for {{ cookiecutter.project_name }}** - -| Name | Default Value | Description | -|-------------------|---------------------|----------------------| -| | | | - - -## Requirements ## - - - ansible >= 2.4 - - python >= 2.6 - -## Dependencies ## - -None - -## Example Playbooks ## - - - -## License ## - -Apache 2.0 diff --git a/ansible-role-tripleo-{{cookiecutter.project_name}}/README.rst b/ansible-role-tripleo-{{cookiecutter.project_name}}/README.rst new file mode 100644 index 0000000..a346f28 --- /dev/null +++ b/ansible-role-tripleo-{{cookiecutter.project_name}}/README.rst @@ -0,0 +1,44 @@ +TripleO {{ cookiecutter.project_name }} +======================================= + +A role to manage {{ cookiecutter.project_name }} tasks for TripleO + +Role Variables +-------------- + +.. list-table:: Variables used for {{ cookiecutter.project_name }} + :widths: auto + :header-rows: 1 + + * - Name + - Default Value + - Description + * - `{{ cookiecutter.project_name|lower|replace('-', '_') }}_debug` + - `False` + - Enable debug option in {{ cookiecutter.project_name }} + +Requirements +------------ + + - ansible >= 2.4 + - python >= 2.6 + +Dependencies +------------ + +None + +Example Playbooks +----------------- + +.. code-block:: + + - hosts: localhost + become: true + roles: + - {{ cookiecutter.project_name }} + +License +------- + +Apache 2.0 diff --git a/ansible-role-tripleo-{{cookiecutter.project_name}}/defaults/main.yml b/ansible-role-tripleo-{{cookiecutter.project_name}}/defaults/main.yml index ed97d53..75fc30b 100644 --- a/ansible-role-tripleo-{{cookiecutter.project_name}}/defaults/main.yml +++ b/ansible-role-tripleo-{{cookiecutter.project_name}}/defaults/main.yml @@ -1 +1,2 @@ --- +{{ cookiecutter.project_name|lower|replace('-', '_') }}_debug: False diff --git a/ansible-role-tripleo-{{cookiecutter.project_name}}/setup.cfg b/ansible-role-tripleo-{{cookiecutter.project_name}}/setup.cfg index ac38708..29141d9 100644 --- a/ansible-role-tripleo-{{cookiecutter.project_name}}/setup.cfg +++ b/ansible-role-tripleo-{{cookiecutter.project_name}}/setup.cfg @@ -2,7 +2,7 @@ name = ansible-role-tripleo-{{ cookiecutter.project_name }} summary = ansible-role-tripleo-{{ cookiecutter.project_name }} - Ansible {{ cookiecutter.project_name }} role for the TripleO project. description-file = - README.md + README.rst author = TripleO Team author-email = {{ cookiecutter.author_email }} home-page = https://git.openstack.org/cgit/openstack/ansible-role-tripleo-{{ cookiecutter.project_name }} diff --git a/ansible-role-tripleo-{{cookiecutter.project_name}}/test-requirements.txt b/ansible-role-tripleo-{{cookiecutter.project_name}}/test-requirements.txt index c3ed418..0bf0fd8 100644 --- a/ansible-role-tripleo-{{cookiecutter.project_name}}/test-requirements.txt +++ b/ansible-role-tripleo-{{cookiecutter.project_name}}/test-requirements.txt @@ -1 +1,2 @@ +docutils # OSI-Approved Open Source, Public Domain hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 diff --git a/ansible-role-tripleo-{{cookiecutter.project_name}}/tox.ini b/ansible-role-tripleo-{{cookiecutter.project_name}}/tox.ini index 0937984..4c351db 100644 --- a/ansible-role-tripleo-{{cookiecutter.project_name}}/tox.ini +++ b/ansible-role-tripleo-{{cookiecutter.project_name}}/tox.ini @@ -20,6 +20,8 @@ commands = bindep test [testenv:pep8] commands = + # Check the readme for python release + python setup.py check --strict -r # Run hacking/flake8 check for all python files bash -c "git ls-files | grep -v releasenotes | xargs grep --binary-files=without-match \ --files-with-match '^.!.*python$' \