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

Automatically disable irrelevant tests for private orbs #203

Open
KyleTryon opened this issue May 10, 2023 · 1 comment
Open

Automatically disable irrelevant tests for private orbs #203

KyleTryon opened this issue May 10, 2023 · 1 comment
Labels
backlog Identified as a backlog item, often combined with low-priority and help-wanted labels enhancement New feature or request

Comments

@KyleTryon
Copy link
Contributor

Describe Request:

This is a continuation of #179. While private orbs are supported by Orb Tools, out of the box a user will experience a failure at first due to RC006 and RC008 which are looking for an accessible home_url and source_url. home_url may not be required for private orbs, and the source_url will return a 404 unless authenticated due to being a private repo.

In order to provide a better experience for private orb developers out of the box, we may want to consider a method of automatically disabling these tests, exclusively for private orbs.

Solution proposal

While not the most scalable, I recommend automatically including these tests in the exclusion list as a part of the orb creation via the orb init command. Most other solutions would both require that we somehow pass along metadata to the orb that it is private, as well as silently skipping the referenced checks.

If we add the exclusions to the config automatically, the orb does not actually require any updates and the user has the test explicitly skipped in their config so that nothing is hidden.

@KyleTryon KyleTryon added backlog Identified as a backlog item, often combined with low-priority and help-wanted labels enhancement New feature or request labels May 10, 2023
@joshbranham
Copy link

Just ran into this today as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog Identified as a backlog item, often combined with low-priority and help-wanted labels enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants