README.md in pdk-0.2.0 vs README.md in pdk-0.3.0
- old
+ new
@@ -50,16 +50,52 @@
```
This displays results in the console:
```
-Running validations on `new_module`:
-* ruby syntax: OK!
-* puppet syntax: OK!
+pdk (INFO): Running all available validators...
+[✔] Checking for missing Gemfile dependencies
+[✔] Checking metadata.json
+[✔] Checking Ruby code style
[...]
```
+Specific validators can be run by providing the validator name (or a comma
+separated list of names) as an argument to `pdk validate`.
+
+```
+$ pdk validate metadata
+[✔] Checking for missing Gemfile dependencies
+[✔] Checking metadata.json
+```
+
+By default each validator will automatically determine which files in the
+module that it should validate, however validations can be run on specific
+files or directories by providing them as arguments to `pdk validate`
+
+```
+$ pdk validate lib/
+[✔] Checking for missing Gemfile dependencies
+[✔] Checking Ruby code style
+```
+
+Some validators support automatic correction of detected problems (for example,
+both rubocop and puppet-lint can automatically correct many common code style
+problems). To enable this functionality, run `pdk validate` with the
+`--auto-correct` option.
+
+```
+$ pdk validate --auto-correct
+pdk (INFO): Running all available validators...
+[✔] Checking for missing Gemfile dependencies
+[✔] Checking metadata.json
+[✔] Checking Puppet manifest style
+[✔] Checking Puppet manifest syntax
+[✔] Checking Ruby code style
+manifests/init.pp:1:10: corrected: double quoted string containing no variables
+```
+
### Run unit tests
The default template sets up [rspec](http://rspec.info/) for Ruby-level unit testing, and [rspec-puppet](https://github.com/rodjek/rspec-puppet/) for catalog-level unit testing.
1. In the module's directory, run all unit tests with:
@@ -260,5 +296,15 @@
# assuming ~/bin is already on your path:
bundle binstubs pdk --path ~/bin
```
Bug reports and pull requests are welcome on GitHub at https://github.com/puppetlabs/pdk.
+
+### Release Process
+
+1. Bump the version in `lib/pdk/version.rb`.
+1. In a clean checkout of master, run `bundle exec rake changelog`.
+1. Edit PR titles and tags, until `bundle exec rake changelog` output makes sense.
+1. Commit and PR the changes.
+1. When the PR is merged, get a clean checkout of the merged commit, and run `bundle exec rake release[upstream]` (where "upstream" is your local name of the puppetlabs remote)
+1. Profit!
+1. Update `lib/pdk/version.rb` with `x.y.z-pre`, commit, and PR to prepare for next release.