Skip to content

Commit

Permalink
Add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tampakrap committed Dec 7, 2015
1 parent 1b6aa0f commit f5b82fe
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
ra10ke
======

[![Gem Version](https://badge.fury.io/rb/ra10ke.svg)](https://badge.fury.io/rb/ra10ke)

Rake tasks related to [R10K](https://github.com/puppetlabs/r10k) and
[Puppetfile](https://github.com/puppetlabs/r10k/blob/master/doc/puppetfile.mkd).

## Usage

Simply add the following line in your `Gemfile`:

```ruby
require 'ra10ke'
```

## Rake tasks

### r10k:syntax

Syntax check for the Puppetfile. Similar to the `r10k puppetfile check`
command.

### r10k:dependencies

This rake task goes through the modules that are declared in the Puppetfile,
and prints outdated modules.

#### Limitations

* It works only with modules from the [Forge](https://forge.puppetlabs.com).
Git and SVN modules will be ignored.
* The version has to be specified explicitly. If it is omitted, or it is
`:latest`, the module will be ignored.

0 comments on commit f5b82fe

Please sign in to comment.