Sherpa for GitHub CLI makes it easy for you to create branches and pull requests associated with any GitHub or Jira issue.
This extension retrieves the type of issue (User Story, Bug, Technical Improvement, etc) and creates a branch or pull request associated with that issue, following the contribution model you define in a configuration file.
- An available GitHub account.
- GitHub CLI (version
2.0.0or higher) configured and authenticated in your development environment. - Bash: Supports Linux, MacOS and Windows (for the latter, we recommend using
WSL2).
Make sure you meet the prerequisites first.
You can install this extension just running this command from your terminal:
gh extension install InditexTech/gh-sherpaIf you have already installed this extension and you want to upgrade it, so, you should run this command from your terminal:
gh extension upgrade sherpaTo remove this extension just run:
gh extension remove sherpaSherpa uses different issue types (feature, bugfix, hotfix, refactoring, etc) when mapping an issue with its
corresponding branch prefix.
By default, it will use the internal/config/default-config.yml configuration
file to perform these mappings.
Otherwise, if you wish customize the different issue types, branch prefixes, etc, so, you can create your own
configuration file localed in $HOME/.config/sherpa/config.yml from the
default config file.
If you are using Jira as issue tracker, so, the first time you run a command it will ask you to configure Jira credentials and then proceed to create the custom configuration file with the provided Jira credentials.
After installing this extension in your development environment, you can know the available commands in the
USAGE.md file.
Before developing any new feature or fix, please, check the CONTRIBUTING.md file. You will find
there the steps to contribute along with development and testing guidelines.
If you find a security vulnerability in this project, please, check the SECURITY.md file to know how to
report it.