civisanalytics / civis-r

Civis API Client for R: https://civisanalytics.com/products/civis-platform/
Other
16 stars 12 forks source link

[APIC-298] 3.0.0 #239

Closed patr1ckm closed 4 years ago

patr1ckm commented 4 years ago

Ok! This should be ready for the 3.0.0 release. I ran through the devtools release checks and it passes on win-builder (the CRAN windows machine).

Screen Shot 2020-06-22 at 9 47 39 AM

A small update was required to the api generation tests that depended on endpoints models_, predictions_ that were removed since the last release.

In addition, I discovered that the file depended heavily on the cached spec from two years ago (I can thank myself for that) so just pinned the tests to that spec.

patr1ckm commented 4 years ago

You mentioned that:

I think changing the default to "latest" qualifies as a breaking change, so I think we should plan for a major version bump

This is a breaking change in default environment for CivisFutures though there are no breaking changes in code. https://semver.org/ is ambiguous on the issue.

I've switched to a minor version upgrade because I think a major version upgrade creates the expectation that users of civis-r may need to make changes to their civis-r code as a result of this release, which they won't.

patr1ckm commented 4 years ago

@mheilman back to you

mheilman commented 4 years ago

We could potentially highlight the default change as a breaking change in the changelog to make it a bit clearer that that's the only reason for the version bump. e.g., - Default docker image for Civis Futures is nowlatestrather than3. This is theoretically a change that could require users to update code (#238)

patr1ckm commented 4 years ago

Thanks! Back to you.