Skip to content

Commit

Permalink
Document breaking changes in v1.1.0
Browse files Browse the repository at this point in the history
- Build branch build_parameters changed in v1.1.0
  • Loading branch information
mtchavez committed May 11, 2017
1 parent 0773d2b commit 38e6404
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,18 @@

# Version 1.1.0 - (2017-03-20)

**Breaking Changes**

* Deprecate all the class methods in favor of classes for object approach
* `Project#build_branch` build parameters changed how they are
passed in. You now need to pass them as the API expects them to be
nested under the `build_parameters` key.

```ruby
# Passing build parameters in the post body
build_params = { build_parameters: { 'MY_TOKEN' => '123asd123asd' } }
res = CircleCi::Project.build_branch 'username', 'reponame', 'branch', {}, build_params
```

# Version 1.0.3 - (2016-09-30)

Expand All @@ -20,7 +31,7 @@

# Version 1.0 - (2016-08-31)

*Breaking Changes*
**Breaking Changes**

* CircleCi::Project#envvars renamed to envvar for consistency with API endpoint
* Deprecated CircleCi::Project#envvars
Expand Down

0 comments on commit 38e6404

Please sign in to comment.