diff --git a/README.md b/README.md index e00ab39..9b478e6 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,30 @@ Herramienta para establecer un workflow siguiendo [Conventional Commits Esta diseñada para facilitar la creación de commits y branches en un formato estandar, que permite derivar versiones automaticamente de los merges sobre ramas principales. +## Instalación + +Para instalar Git Flow, se sugiere utilizar [pipx](https://github.com/pypa/pipx) (seguir la +documentación para instalarlo). Una vez instalado `pipx`, simplemente clonamos el repositorio en una +carpeta local, y lo instalamos: + +```sh +cd ~/Downloads +git clone git@bitbucket.org:sushi2717/git-flow.git +cd git-flow +pipx install . +``` + +Luego podemos verificar que se haya instalado correctamente ejecutando: `git-flow -h` + +Para actualizarlo, hacemos un pull de los cambios recientes del repositorio, y hacemos el upgrade +mediante `pipx`: + +```sh +cd ~/Downloads/git-flow +git pull +pipx upgrade git-flow +``` + ## Configuración Para poder usar la herramienta en un repositorio, necesitamos inicializarlo: @@ -22,18 +46,15 @@ El comando solicitará 2 opciones: - **Remoto** (opcional): Nombre del remoto que se usará para crear PRs, y taggear merges automáticamente. Por el momento, se soportan los siguientes remotos: - - [x] Bitbucket - - [ ] Github: planeado + - [x] Bitbucket + - [ ] Github: planeado La configuración del remoto requiere tener un API Token para poder crear los PRs automáticamente. El mismo se puede crear desde: *"Atlassian Account Settings" > "Security" > "Create and Manage API Tokens" > "Create API Tokens with scopes"*. El token necesita el scope `write:pullrequest:bitbucket` - - `write:repository:bitbucket` - - Luego se debe guardar el token dentro del repositorio a configurar, en el archivo `.repository-token`. - - De no especificarse, los merges y tags se harán de forma local. + Luego se debe guardar el token dentro del repositorio a configurar, en el archivo + `.repository-token`. De no especificarse, los merges y tags se harán de forma local. ## Utilización