-
Notifications
You must be signed in to change notification settings - Fork 171
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 make registry.json
command
#347
Conversation
Functional test, check! Should we add plugins/registry.json to .gitignore? |
Do you think it might make sense to include the name of the executable? For example, I would be more likely to name my cred for Oh Dear |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me! A couple of questions for consideration:
- Should we support multiple credentials in the registry? When in the future multiple credentials are supported, we'd want to record separate management URLs for them. One example is ngrok: right now the authtoken and API Key are bundled together as one credential, but it'd be ideal to have them as individual credentials.
- For shell plugins without a management URL, are we directing to the docs page?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not necessarily questions but some drive-by thought processes:
Multi-executable shell plugins, and shell plugins that depend on other company secrets. Homebrew is an example of the latter, which uses GitHub Personal Access Tokens for authentication.
If we are doing pattern matching based on the platform name, for example, should we show only the GitHub shell plugin (on the banner) on a GitHub secret, or show the Homebrew shell plugin as well?
If we are pattern matching with the URL in the secret item, should we show both GitHub and Homebrew shell plugins in that banner? If we choose to show more than one, will that constraint what we can show within that banner?
Added to
I suggest we carry out this discussion on the internal MR where this json gets used, as the PR here lacks context about the current intended consumption mechanism for this json. |
good point! I'll make sure to open an internal ticket about this. 😄
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Current changes look good to me!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me for this iteration, can discuss improvements or other changes internally later.
Overview
This PR adds a
make registry.json
command, generating a json-formatted registry.For the time being, this will be used as configuration for the Shell Plugins banners that OPH renders for Shell Plugins items. However, this can also serve as boilerplate for more complex configuration that can be built on top of this repo.
Type of change
How To Test
Run
make registry.json