README.md in stove-1.0.1 vs README.md in stove-1.1.0

- old
+ new

@@ -9,11 +9,12 @@ - Edit the `metadata.rb` and insert the proper version - Create a CHANGELOG from JIRA tickets - Commit and push these changes to git - Create a git tag and push those changes to git -- Upload the cookbook to the Opscode community site +- Publish a release to GitHub releases +- Upload the cookbook to the Opscode Community Site - Resolve (close) the JIRA tickets Why? ---- @@ -37,22 +38,30 @@ ```javascript { "jira_username": "JIRA_USERNAME", "jira_password": "JIRA_PASSWORD", "opscode_username": "OPSCODE_USERNAME", - "opscode_pem_file": "OPSCODE_PEM_FILE" + "opscode_pem_file": "OPSCODE_PEM_FILE", + "github_access_token": "PERSONAL_API_TOKEN" } ``` +- `jira_username` - The username used to login to Opscode's JIRA +- `jira_password` - The password used to login to Opscode's JIRA +- `opscode_username` - The username used to login to Opscode's Community Site +- `opscode_password` - The password used to login to Opscode's Community Site +- `github_access_token` - Your personal access token for the GitHub API + For example: ```javascript { "jira_username": "sethvargo", "jira_password": "bAc0ñ", "opscode_username": "sethvargo", - "opscode_pem_file": "~/.chef/sethvargo.pem" + "opscode_pem_file": "~/.chef/sethvargo.pem", + "github_access_token": "abcdefg1234567" } ``` Usage @@ -65,16 +74,32 @@ Usage: bake x.y.z -l, --log-level [LEVEL] Ruby log level -c, --category [CATEGORY] The category for the cookbook (optional for existing cookbooks) -p, --path [PATH] The path to the cookbook to release (default: PWD) --[no-]git Automatically tag and push to git (default: true) + --[no-]github Automatically release to GitHub (default: true) -r, --remote The name of the git remote to push to -b, --branch The name of the git branch to push to + --[no-]devodd Automatically bump the metadata for devodd releases --[no-]jira Automatically populate the CHANGELOG from JIRA tickets and close them (default: false) --[no-]upload Upload the cookbook to the Opscode Community Site (default: true) --[no-]changelog Automatically generate a CHANGELOG (default: true) -h, --help Show this message -v, --version Show version +``` + + +Rake Task +--------- +Stove also includes a Rake task you can include in your Rakefile: + +```ruby +require 'stove/rake_task' + +Stove::RakeTask.new do |stove| + stove.git = true + stove.devodd = true +end ``` Contributing ------------