From 28ad1a064a261852c6a6a73cc7b8b9dbb84a8ed2 Mon Sep 17 00:00:00 2001 From: Chavez Date: Fri, 26 May 2017 11:16:18 -0700 Subject: [PATCH] Update CHANGELOG and README for v2 release - Add example to CHANGELOG - Add note of breaking changes in v2 to README --- CHANGELOG.md | 23 ++++++++++++++++++++++- README.md | 5 +++++ 2 files changed, 27 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4302e6b..a5c22ca 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,29 @@ # Version 2.0.0 (Unreleased) -**Breaking Changes*** +## Breaking Changes * Remove all deprecated class methods in favor of instance API resources classes + * Please look at the documentation in the README or rubydoc on changes. An example of a change might be: + + ```ruby + # + # Old way of getting recent builds + # + builds = CircleCi::Project.recent_builds 'mtchavez', 'circleci' + + # + # New way with a project object + # + project = CircleCi::Project.new 'mtchavez', 'circleci' + builds = project.recent_builds + + # Can interact with other calls for the project + project.build # make a new build + project.settings # get settings + project.clear_cache #clear the cache + ``` + + ## Other changes diff --git a/README.md b/README.md index 28a6ec1..f837225 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,11 @@ Circle CI API Wrapper. Requires ruby `>= 2.0.0`. +**Version 2.x has breaking changes from v1.x** +> Please use branch v-1.1.0 or tag v1.1.0 for previous 1.x version of +> the gem until you can update to the latest version. 1.x will not be supported +> in the longer term. + ## Install ```ruby