This repository has been archived by the owner on Jan 29, 2022. It is now read-only.
Preparing the README for Pre-Release #19
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dhollinger
requested review from
alexjfisher,
ekohl,
bastelfreak and
rnelson0
bastelfreak
approved these changes
Nov 11, 2017
README.md
Outdated
| ## Prerequisites | ||
|
|
||
| * Ruby 2.1.9 or greater | ||
| * Puppet 4.7.0 or greater |
There was a problem hiding this comment.
Is this a hard requirement or only listed because Vox Pupuli supports it? If so, we should bump it to 4.7.1, that is the lowest version we should support in our modules.
README.md
Outdated
|
|
||
| `gem install puppet_webhook` | ||
|
|
||
| RPM and DEB packages are planned for future releases. |
There was a problem hiding this comment.
side node: I can provide archlinux packages if you like, as soon as a gem is published.
README.md
Outdated
| ## Usage | ||
|
|
||
| ### Running puppet_webhook | ||
| Once installed, you can run the application by simply executing the `puppet_webhook` binary. |
There was a problem hiding this comment.
for valid markdown, we need a newline between heading and text.
| public_key_path: '' | ||
| private_key_path: '' | ||
| command_prefix: 'umask 0022;' | ||
| github_secret: ~ |
There was a problem hiding this comment.
~ \o/ ( thousand times cooler than using empty string, which people often do)
bastelfreak
reviewed
Nov 13, 2017
| @@ -7,6 +7,203 @@ | |||
| [](https://coveralls.io/github/voxpupuli/puppet-webhook?branch=master) | |||
| [](https://gemnasium.com/github.com/voxpupuli/puppet-webhook) | |||
|
|
|||
| The puppet webhook server is a Sinatra-based application for receiving webhooks that will trigger r10k runs on your puppet master. | |||
| ## What is puppet_webhook | |||
bastelfreak
approved these changes
Nov 13, 2017
bastelfreak
approved these changes
Nov 13, 2017
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an initial pass at the docs in the README before we release a alpha/beta of the
puppet_webhookapp