development.md

Development

Setup environment

bundle install

Running checks

rubocop

bundle exec rake rubocop

syntax lint

bundle exec rake syntax lint

metadata lint

bundle exec rake metadata_lint

spec

bundle exec rake spec

Updating documentation

bundle exec puppet strings generate --out ./doc/reference.md --format markdown manifests/{init,unmanaged,params}.pp

Contributing

Please use Git Flow when contributing to this project.

1. Fork the reference repository
2. Create a feature branch

   git flow feature start foo

3. Implement your change
   • Do not forget to also update tests and documentation
4. Run all checks locally
5. Commit
6. Publish your feature branch

   git flow feature publish

7. Create a pull request toward the develop branch

Release

1. Start a new release

   git flow release start MAJOR.MINOR

2. Bump version in metadata.json and commit
3. Update CHANGELOG.md and commit
4. Finish the release

   git flow release finish MAJOR.MINOR -m MAJOR.MINOR.PATCH -T MAJOR.MINOR.PATCH -p