If VCS type is optional, it should be a named arg

[ghostsquad]

Issue

The documentation for using Build/Project in version 2.0 seems to point out a UX issue.

If the VCS type is optional, then it should be a named arg with a default value. This would greatly improve the UX of using this gem.

Steps to reproduce

build = CircleCi::Build.new 'username', 'project', nil, '1234'

Expected behavior

build = CircleCi::Build.new 'username', 'project', '1234'
build = CircleCi::Build.new 'username', 'project', '1234', vcs: 'github'

Proposals

This is backwards incompatible change for 2.0, so this may need to be implemented in 3.0

[mtchavez]

@ghostsquad Hey thanks for pointing this out. As this does look visually better with a named argument, it was somewhat intentional because it is a required addition with the latest version of the CircleCI API. The idea around it being set up this way is that no single VCS should be a first class citizen ultimately. I know that Github was the original supported VCS by CircleCI, and that is mostly why it is defaulted to this right now because it will be the default for the majority of people. However, CircleCI has since opened up to allow Bitbucket and when/if others get added there will be an argument for there not being a default at all and requiring more explicit usage.

I'm going to leave this open for now so I can think about it some more and not forget about it. I could maybe see doing some kind of VCS wrapper class, or subclass, that pass their VCS name into the current API resource classes for convenience. This kind of approach would allow for backwards compatibility as well as make future VCS types easier to handle theoretically.