puppet-openstack-cookiecutter/README.md
ZhongShengping c29ef2a8bf Fix Repository
Change-Id: Ie62a036c68af67e6c309794c9b9ffb712b28f80f
2019-04-21 07:25:49 +00:00

32 lines
1.3 KiB
Markdown

Team and repository tags
========================
[![Team and repository tags](https://governance.openstack.org/tc/badges/puppet-openstack-cookiecutter.svg)](https://governance.openstack.org/tc/reference/tags/index.html)
<!-- Change things from this point on -->
# puppet-openstack-cookiecutter
Cookiecutter template for a compliant OpenStack puppet-modules
## Installation
Install [cookiecutter](https://cookiecutter.readthedocs.org/) either from source, pip or package if it exists
## Usage
There are two ways to create the boilerplate for the puppet module.
### Locally
1. Clone locally the [puppet-openstack-cookiecutter](https://opendev.org/openstack/puppet-openstack-cookiecutter/) repository.
2. Run `cookiecutter /path/to/cloned/repo`
### Remotely (ie. using a git repo)
1. Run `cookiecutter https://opendev.org/openstack/puppet-openstack-cookiecutter.git`
## What's next
Once the boilerplate created, in order to be compliant with the other modules, the files managed by [msync](https://github.com/puppet-community/modulesync), (or [configs](https://opendev.org/openstack/puppet-modulesync-configs/)) needs to be in the project folder. Once synced module is ready, announce its existence to the ML, make the proper patch to openstack-infra and finally wait for the reviews to do the rest.