Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/InditexTech/gh-sherpa
Streamline branch and pull request creation for Jira or GitHub issues from command line
https://github.com/InditexTech/gh-sherpa
command-line contributing gh-extension golang inditex sherpa
Last synced: about 1 month ago
JSON representation
Streamline branch and pull request creation for Jira or GitHub issues from command line
- Host: GitHub
- URL: https://github.com/InditexTech/gh-sherpa
- Owner: InditexTech
- License: apache-2.0
- Created: 2023-05-08T13:41:16.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-28T15:52:29.000Z (4 months ago)
- Last Synced: 2024-05-29T05:19:18.532Z (4 months ago)
- Topics: command-line, contributing, gh-extension, golang, inditex, sherpa
- Language: Go
- Homepage:
- Size: 224 KB
- Stars: 47
- Watchers: 1
- Forks: 2
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://sonarcloud.io/summary/new_code?id=InditexTech_gh-sherpa)
[](https://sonarcloud.io/summary/new_code?id=InditexTech_gh-sherpa)[](https://sonarcloud.io/summary/new_code?id=InditexTech_gh-sherpa)
# Sherpa extension for GitHub CLI
Sherpa for [GitHub CLI](https://github.com/cli/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](#configuration).
## Table of contents
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Contribute](#contribute)
## Prerequisites
- An available GitHub account.
- [**GitHub CLI**](https://github.com/cli/cli) (version `2.0.0` or higher) configured and
[authenticated](https://cli.github.com/manual/gh_auth_login) in your development environment.
- **Bash**: Supports Linux, MacOS and Windows (for the latter, we recommend using
[`WSL2`](https://learn.microsoft.com/en-us/windows/wsl/install)).
## Installation
Make sure you meet the [prerequisites](#prerequisites) first.
You can **install** this extension just running this command from your terminal:
```sh
gh extension install InditexTech/gh-sherpa
```
### Upgrade
If you have already installed this extension and you want to **upgrade** it, so, you should run this command from your
terminal:
```sh
gh extension upgrade sherpa
```
### Remove
To **remove** this extension just run:
```sh
gh extension remove sherpa
```
## Configuration
Sherpa uses different issue types (`feature`, `bugfix`, `hotfix`, `refactoring`, etc) when mapping an issue with its
corresponding branch prefix.
### Default configuration
By default, it will use the [`internal/config/default-config.yml`](internal/config/default-config.yml) configuration
file to perform these mappings.
### Custom configuration
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](internal/config/default-config.yml).
> 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.
## Usage
After installing this extension in your development environment, you can know the available commands in the
[`USAGE.md`](docs/USAGE.md) file.
## Contribute
Before developing any new feature or fix, please, check the [`CONTRIBUTING.md`](CONTRIBUTING.md) file. You will find
there the steps to contribute along with development and testing guidelines.
## Security
If you find a security vulnerability in this project, please, check the [`SECURITY.md`](SECURITY.md) file to know how to
report it.