Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/costajob/git_commands
Utility library to rebase and aggregate your project branches
https://github.com/costajob/git_commands
git ruby scm workflow
Last synced: 13 days ago
JSON representation
Utility library to rebase and aggregate your project branches
- Host: GitHub
- URL: https://github.com/costajob/git_commands
- Owner: costajob
- License: mit
- Created: 2014-01-31T09:56:31.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2020-07-09T07:42:56.000Z (over 4 years ago)
- Last Synced: 2024-04-25T07:01:53.395Z (6 months ago)
- Topics: git, ruby, scm, workflow
- Language: Ruby
- Homepage:
- Size: 102 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Table of Contents
* [Workflow](#workflow)
* [Scope](#scope)
* [Installation](#installation)
* [GIT](#git)
* [Usage](#usage)
* [Arguments](#help)
* [Help](#help)
* [Repository](#repository)
* [Branches](#branches)
* [Commands](#commands)
* [Rebase](#rebase)
* [Remove](#remove)
* [Aggregate](#aggregate)
## Workflow
This script facilitates adopting a subset of the branch-featuring workflow characterised by:
* each feature will have its own branch
* integration of feature branch with defaukt one happens via rebasing to maintain a straight commits line
* is not an issue to `force-with-lease` push feature pranch to origin
* release branches are created aggregating multiple branches
## Scope
The scope of this gem is helping out in the following cases:
* you have multiple feature branches waiting for release due to some reason (i.e. long QA time...), and need to keep them aligned with master
* you need to quickly aggregate branches for a release
* you want to cleanup local and remote branches upon release
## Installation
Just install the gem to use the binaries commands.
```
gem install git_commands
```
### GIT
The library uses the Ruby command line execution to invoke the **git** command as a separate process.
I assume you have the GIT program on your path.
## Usage
Here are the main commands:
### Arguments
All of the available commands come with the same set of arguments:
#### Help
Display the help of a specific command by:
```
rebase --help
Usage: rebase --repo=/Users/Elvis/greatest_hits --origin=upstream --default=production --branches=feature/love_me_tender,fetaure/teddybear
-r, --repo=REPO The path to the existing GIT repository
-o, --origin=ORIGIN Specify the remote alias (origin)
-d, --default=DEFAULT Specify the default branch (master)
-b, --branches=BRANCHES Specify branches as: 1. a comma-separated list of names 2. the path to a file containing names on each line 3. via pattern matching
-h, --help Prints this help
```
#### Repository
You have to specify the absolute path to the GIT repository you want to work with. The path must be a folder initialized as a valid GIT repository (a check via *rev-parse* is performed), otherwise an error is raised:
```
rebase --repo=invalid
'invalid' is not a valid GIT repository!
```
#### Branches
As with the repository you always have to specify the list of branches you want to work with. There are different options:
##### List of branches
Specify a comma separated list of branch names:
```
rebase --repo=/Users/Elvis/greatest_hits --branches=feature/love_me_tender,feature/teddybear,feature/return_to_sender
Loading branches file...
Successfully loaded 3 branches:
01. feature/love_me_tender
02. feature/teddybear
03. feature/return_to_sender
```
##### Path to a names file
Specify an absolute path to a file containing the branches names on each line:
File */Users/Elvis/greatest_hits/.branches*:
```
feature/love_me_tender
feature/teddybear
feature/return_to_sender
feature/in_the_ghetto
```
```
rebase --repo=/Users/Elvis/greatest_hits --branches=/Users/Elvis/greatest_hits/.branches
Loading branches file...
Successfully loaded 4 branches:
01. feature/love_me_tender
02. feature/teddybear
03. feature/return_to_sender
04. feature/in_the_ghetto
```
##### Pattern matching
In case you want to work with a set of branches with a common pattern, you have to specify a greedy operator with the wild card you want to match.
Just consider you have not to specify *origin/* as the name of the branch, since is managed by the script for you:
```
rebase --repo=/Users/Elvis/greatest_hits --branches=*der
Loading branches file...
Successfully loaded 2 branches:
01. feature/love_me_tender
02. feature/return_to_sender
```
##### Checking
Each loaded branch is validated for existence (but for branches loaded via pattern matching, already fetched from origin).
In case the validation fails, the branch is filtered from the resulting list.
```
rebase --repo=/Users/Elvis/greatest_hits --branches=noent,feature/love_me_tender
Loading branches file...
Successfully loaded 1 branch:
01. feature/love_me_tender
```
In case no branches have been loaded, an error is raised:
```
rebase --repo=/Users/Elvis/greatest_hits --branches=noent1,noent2
No branches loaded!
```
##### Default branch
Default branch cannot be included into the branches list for obvious reasons:
```
rebase --repo=/Users/Elvis/greatest_hits --branches=master,feature/love_me_tender
Loading branches file...
Successfully loaded 1 branch:
01. feature/love_me_tender
```
### Commands
Here are the available GIT commands:
#### Rebase
This command is useful in case you have to rebase several branches with _origin/master_ (or another specified default) frequently.
A confirmation is asked to before rebasing.
```
rebase --repo=/Users/Elvis/greatest_hits --branches=feature/love_me_tender,feature/teddybear,feature/return_to_sender
...
```
##### Changing origin
The rebasing runs considering `master` branch as the default one and `origin` as the remote alias.
In case you need to rebase against a different origin and default branch you can specify them by command line:
```
rebase --repo=/Users/Elvis/greatest_hits --origin=upstream --default=production --branches=feature/love_me_tender
Loading branches file...
Successfully loaded 1 branch:
01. feature/love_me_tender
Proceed rebasing these branches with upstream/production (Y/N)?
```
#### Remove
This command remove the specified branches locally and remotely.
A confirmation is asked before removal.
```
remove --repo=/temp/top_20 --branches=*obsolete*
...
```
#### Aggregate
This command aggregates all of the specified branches into a single one in case you want to create a release branch.
A confirmation is asked before aggregating.
```
aggregate --repo=/Users/Elvis/greatest_hits --branches=*ready*
...
```
##### Aggregate naming
The created aggregate branch follows a default naming convention pattern:
`release/`
Each of the term within the `<` and `>` chars are replaced by related (upcased) environment variables, but for the `timestamp`, that is computed at runtime in the `yyyymmdd` format.
Consider a valid pattern should at least contain one replaceable part within the `<` and `>` chars.
You can overwrite the naming pattern by specifying the following environment variables:
* `AGGREGATE_NAME` - the name to be used directly for the aggregator branch, without any pattern replacements
* `AGGREGATE_PATTERN` - change the default pattern by specifying the related environment variables for each parts within the `<` and `>` chars
###### Examples
Passing directly the aggregate name:
```shell
AGGREGATE_NAME=my_aggregate aggregate --repo=/Users/Elvis/greatest_hits --branches=*ready*
...
Aggregate branches into my_aggregate (Y/N)?
```
Using the default pattern:
```shell
aggregate --repo=/Users/Elvis/greatest_hits --branches=*ready*
...
Aggregate branches into release/20170307 (Y/N)?
```
Using a custom pattern:
```shell
RELEASE_TYPE=bugfix \
RISK=HIGH \
PROGRESSIVE=3 \
AGGREGATE_PATTERN="release/rc-.__" aggregate --repo=/Users/Elvis/greatest_hits --branches=*ready*
...
Aggregate branches into release/rc-3.bugfix_HIGH_20170307 (Y/N)?
```