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

feat: support allowed github urls #771

Merged
merged 5 commits into from
Mar 28, 2024
Merged

feat: support allowed github urls #771

merged 5 commits into from
Mar 28, 2024

Conversation

mdonnalley
Copy link
Contributor

@mdonnalley mdonnalley commented Mar 27, 2024

What does this PR do?

  • Support allow-listed github urls (e.g. https://github.com/oclif/plugin-version)
    • only https://github.com/<org>/<repo> is supported. You cannot use https://github.com/<org>/<repo>.git, https://github.com/<org>/<repo>#commit, etc...
  • Display plugin name in prompt instead of This plugin

What issues does this PR fix or reference?

@W-15313997@

@mdonnalley mdonnalley requested a review from a team as a code owner March 27, 2024 16:21
@iowillhoit
Copy link
Contributor

QA NOTES

Install logging

  • 🟢 Plugin name is now shown with an npm install
    • 🟢 sf plugins install foo
  • 🟢 An org/repo install shows the full github url in the message
    • sf plugins install oclif/plugin-version
  • 🟢 Prompts with full url with version
    • sf plugins install https://github.com/oclif/plugin-version.git#2.0.11
  • 🟢 Prompts with full url with branch
    • sf plugins install https://github.com/oclif/plugin-version.git#ew/testing-plugin-plugins-npm-branch-installs
  • 🟢 Prompts with "github notation"
    • sf plugins install github:oclif/plugin-version
  • 🟡 Nitpick: there is an extra , at the end of the confirmation: [...] Do you want to continue the installation?, (y/N)

Allowlisting

  • 🟢 Can allowlist github:oclif/plugin-version
  • 🟢 Can allowlist https://github.com/oclif/plugin-version
  • 🟢 Can allowlist https://github.com/oclif/plugin-version.git
  • 🟠 You can install with sf plugins install oclif/plugin-version but cannot allowlist with oclif/plugin-version
    • NOTE: oclif/plugin-version does work with https://github.com/oclif/plugin-version in the allowlist

@iowillhoit iowillhoit merged commit c11247b into main Mar 28, 2024
11 checks passed
@iowillhoit iowillhoit deleted the mdonnalley/improvements branch March 28, 2024 18:57
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.

2 participants