Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add vcs-type parameter and change to v1.1 API #14

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

tylux
Copy link

@tylux tylux commented Nov 9, 2017

Version Control System (:vcs-type)

New with v1.1 of the api, for endpoints under /project you will now need to tell CircleCI what version control system type your project uses. Current choices are ‘github’ or ‘bitbucket’.

@jszwedko
Copy link
Owner

👍 thanks for starting this discussion @tylux

My main hesitation with this is that it is a breaking change to API. I'll think about it a bit more, but I'm curious if there are any clever ways we could keep the current API and also add support for v1.1 absent maintaining separate branches.

The right answer may also be to just flip the switch and force people to upgrade as you've done here.

I'm not sure why CI didn't run on this PR, but the tests will need to be updated too.

@kudrykv
Copy link
Contributor

kudrykv commented Nov 16, 2017

@jszwedko you can use gopkg.in to version library.
Simply create a branch named e.g. v2, then gopkg.in/jszwedko/go-circleci.v2 will point to your repo to the v2 branch.
Then, one can pull that by go get gopkg.in/jszwedko/go-circleci.v2.

@martinssipenko
Copy link

@jszwedko Any updates on this matter?

@tgermain
Copy link

tgermain commented Dec 4, 2018

I think your modifications break the tests @tylux
You may find a fix here

@phamdt
Copy link

phamdt commented Feb 12, 2019

also interested in this PR

@jszwedko
Copy link
Owner

Apologies for falling off on this one. I think v1.1 of Circle's API has been around long enough that we could make it the default, but I'd still like to provide an easy way for projects depending on the old API to continue using the client (i.e. minimize the amount of changes they'd need to make to continue relying on the library).

I think this could be possible by moving master to a v1 branch that will only get bug fixes, create a v1.1 branch pinned to v1.1 of the CircleCI API that people can pin their projects to, and have master track the latest API version.

I'll try to follow up on this soon. I think it's also an opportunity to see if we can make other backwards incompatible improvements to the API of this library.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants