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

Inconsistent install instructions #31

Closed
garethr opened this issue Oct 30, 2019 · 3 comments
Closed

Inconsistent install instructions #31

garethr opened this issue Oct 30, 2019 · 3 comments
Assignees

Comments

@garethr
Copy link

garethr commented Oct 30, 2019

On https://circleci.com/orbs/registry/orb/kenfdev/conftest-orb#commands-install, the Orb Quickstart Guide shows

orbs:
  conftest-orb: kenfdev/conftest-orb@0.0.9

While the Usage Examples show:

orbs:
  conftest: kenfdev/conftest-orb@x.y

Note the different name contfest-orb vs conftest. The later is cleaner I think.

@kenfdev
Copy link
Owner

kenfdev commented Nov 12, 2019

Thanks for pointing this out! I'll fix this.

@kenfdev kenfdev self-assigned this Nov 12, 2019
@kenfdev
Copy link
Owner

kenfdev commented Nov 12, 2019

I've dug into this and found that it's difficult... It seems this Quickstart guide is automatically generated and the orbs name is pulled from the registry name in CircleCI.

I'll have to drop the registry and create a new orb to solve this issue which will be a pretty big impact 🤔

@garethr
Copy link
Author

garethr commented Nov 13, 2019

Ah, in which case I wouldn't worry. Both work. Thanks for checking.

@garethr garethr closed this as completed Nov 13, 2019
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

No branches or pull requests

2 participants