feat: plugin-add command can take git branch name. #1204
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously it was only possible to clone plugin repos on their default branch. This pull-request allows the `plugin-add` command to take an aditional argument for specifying a git-ref used for `git clone`. Note: The `plugin-update` command already was able to take a `git-ref`, but this feature eliminates the need of doing `plugin-add` and immediatly `plugin-update` just for setting the git-ref to use. Sometimes it's convenient to specify another plugin-repo branch or release-tag, instead of using the repos' default branch. For example, if a plugin becomes unstable on its default branch because a bug was introduced, or if the fix is only available at an experimental branch, people might want to try those changes. Also, some advanced plugins, like [asdf-direnv](https://github.com/asdf-community/asdf-direnv) can have tagged releases or `develop` branches that can potentially be more *experimental* but more feature-forward than the `master` branch. Added a test that exercises clonning using an specific branch name. Documented on help.txt and had keep all other commands help aligned. Closes asdf-vm#1201
jthegedus
approved these changes
May 24, 2022
This was referenced Jul 17, 2022
|
👀 |
|
What's needed to merge this PR? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Previously it was only possible to clone plugin repos on their default branch.
This pull-request allows the
plugin-addcommand to take an aditionalargument for specifying a git-ref used for
git clone.Note: The
plugin-updatecommand already was able to take agit-ref,but this feature eliminates the need of doing
plugin-addand immediatlyplugin-updatejust for setting the git-ref to use.Motivation
Sometimes it's convenient to specify another plugin-repo branch or release-tag,
instead of using the repos' default branch.
For example, if a plugin becomes unstable on its default branch because
a bug was introduced, or if the fix is only available at an experimental
branch, people might want to try those changes.
Also, some advanced plugins, like
asdf-direnv can have
tagged releases or
developbranches that can potentially bemore experimental but more feature-forward than the
masterbranch.Other information
Added a test that exercises clonning using an specific branch name.
Documented on help.txt and had keep all other commands help aligned.
Closes #1201
Closes #166