diff --git a/CHANGELOG.md b/CHANGELOG.md index 83bdb36..17b4a57 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,9 @@ All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a changelog](https://github.com/olivierlacan/keep-a-changelog). ## Unreleased +### Added +- * Add boilerplate README.md* @vicsufer + ## [1.0.1](https://github.com/idealista/cookiecutter-ansible-role/tree/1.0.1) (2020-09-17) ## [Full Changelog](https://github.com/idealista/cookiecutter-ansible-role/compare/1.0.0...1.0.1) ### Removed diff --git a/{{cookiecutter.app_name}}_role/CHANGELOG.md b/{{cookiecutter.app_name}}_role/CHANGELOG.md index e69de29..4a8cc20 100644 --- a/{{cookiecutter.app_name}}_role/CHANGELOG.md +++ b/{{cookiecutter.app_name}}_role/CHANGELOG.md @@ -0,0 +1,18 @@ +# Change Log + +All notable changes to this project will be documented in this file. +This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a changelog](https://github.com/olivierlacan/keep-a-changelog). + +## [Unreleased](https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.app_name }}_role/tree/develop) +### Changed +### Added +### Removed +### Fixed + +## [X.Y.Z](https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.app_name }}_role/tree/X.Y.Z) +### [Full Changelog](https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.app_name }}_role/compare/1.0.0...X.Y.Z) +### Changed + *[#](https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.app_name }}_role/issues/) \* @\ + +## [1.0.0](https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.app_name }}_role/tree/1.0.0) +- Initial release diff --git a/{{cookiecutter.app_name}}_role/README.md b/{{cookiecutter.app_name}}_role/README.md index 930381f..77bdf94 100644 --- a/{{cookiecutter.app_name}}_role/README.md +++ b/{{cookiecutter.app_name}}_role/README.md @@ -26,7 +26,7 @@ These instructions will get you a copy of the role for your Ansible playbook. On ### Prerequisities -Ansible 2.8.x.x version installed. +Ansible {{ cookiecutter.ansible_version }} version installed. Molecule 3.x.x version installed. @@ -86,7 +86,7 @@ $ pipenv run molecule test ## Versioning -For the versions available, see the [tags on this repository](https://github.com/idealista/{{ cookiecutter.app_name }}_role/tags). +For the versions available, see the [tags on this repository](https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.app_name }}_role/tags). Additionaly you can see what change in each version in the [CHANGELOG.md](CHANGELOG.md) file. @@ -94,7 +94,7 @@ Additionaly you can see what change in each version in the [CHANGELOG.md](CHANGE * **Idealista** - *Work with* - [idealista](https://github.com/idealista) -See also the list of [contributors](https://github.com/idealista/{{ cookiecutter.app_name }}_role/contributors) who participated in this project. +See also the list of [contributors](https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.app_name }}_role/contributors) who participated in this project. ## License