Merge pull request #541 from zendesk/bump-v3.0.0-changelog

v3.0.0 CHANGELOG

Author: fbvilela

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## Unreleased
 
-## v3.0.0.rc1
+## v3.0.0
 
 In this version, We are bringing Cursor Based Pagination (CBP) support to all supported endpoints. This is in line with the [limits announcement](https://support.zendesk.com/hc/en-us/articles/5591904358938-New-limits-for-offset-based-pagination) made by Zendesk to promote system reliability and also CBP usage.
 
@@ -16,6 +16,7 @@ In this version, We are bringing Cursor Based Pagination (CBP) support to all su
 - OBP support will be further limited in the Zendesk APIs and will be deprecated soon. We are working to ensure all Zendesk APIs support CBP and transition for the customers is smooth
 - The order of the returned results is different in CBP from OBP at times depending on the endpoint behaviour and support for ordering. Please note that any ordering was never hard-coded or built-in so it is not guaranteed. We recommend that you pick the relevant sort/order needed for your workflows and pass them explicitly when making the API call via the library
 - This is a Beta-release and we seek your feedback, experiences. Please open an issue or create a PR to help us work with you
+- v1 of this gem is not compatible with Faraday 1. We are releasing a new version with CBP support on August 1st with the version `v3.0.0`. Once the new version is released, we will no longer support the v1 officially
 
 ## v2.0.1
 

README.md

@@ -432,12 +432,13 @@ bundle exec rubocop # Runs the lint (use `--fix` for autocorrect)
 ## Releasing a new gem version
 
 1. From updated master: `git checkout -b bump-vX.X.X`, according to [SemVer](https://semver.org)
-1. Ensure the CHANGELOG is correct and updated, this is your last opportunity
-2. Execute `bundle exec bump patch --tag`, or minor or major, this bumps the version in your local machine in the latest commit
-3. Push to GitHub `git pull && git push origin vX.X.X`
-4. Raise a PR and get it approved and merged
-5. Post a message in Slack `#rest-api`, so advocacy are aware that we are going to release a new gem, just in case any customer complains about something related to the gem
-6. After 2 hours from the above message, you can [approve the release of the gem](https://github.com/zendesk/zendesk_api_client_rb/deployments/activity_log?environment=rubygems-publish)
+2. Ensure the CHANGELOG is correct and updated, this is your last opportunity
+3. Execute `bundle exec bump patch --tag # minor|major`, this bumps the version in a new commit, and adds the relative git tag
+4. Push to GitHub `git push origin vX.X.X -u && git push --tags`
+5. Raise a PR ([example](https://github.com/zendesk/zendesk_api_client_rb/pull/540)) including the code diff ([example](https://github.com/zendesk/zendesk_api_client_rb/compare/v2.0.1...v3.0.0.rc1))
+6. Get it approved and merged
+7. Post a message in Slack `#rest-api` (example **TODO**), so advocacy are aware that we are going to release a new gem, just in case any customer complains about something related to the gem
+8. After 2 hours from the above message, you can [approve the release of the gem](https://github.com/zendesk/zendesk_api_client_rb/deployments/activity_log?environment=rubygems-publish)
 
 ## Contributing