Mirrors/cookiecutter-ansible-role
1
0
Fork 1
mirror of https://github.com/idealista/cookiecutter-ansible-role.git synced 2024-11-23 19:07:00 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #14 from idealista/feature/changelog-boilerplate

Browse Source 
Boilerplate for CHANGELOG.md
This commit is contained in:
Víctor Suárez Fernández 2020-10-06 08:16:42 +02:00 committed by GitHub
commit 694e944229
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 24 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGELOG.md
View File

@ -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

18
{{cookiecutter.app_name}}_role/CHANGELOG.md
View File

@ -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
*[#<issue_number>](https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.app_name }}_role/issues/<issue_number>) \<Change description\>* @\<author\>
## [1.0.0](https://github.com/{{ cookiecutter.github_user }}/{{ cookiecutter.app_name }}_role/tree/1.0.0)
- Initial release

6
{{cookiecutter.app_name}}_role/README.md
View File

@ -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