| Name | gitbrancher JSON |
| Version |
1.2.1
JSON |
| download |
| home_page | None |
| Summary | Manage git workflow between multiple branches |
| upload_time | 2024-07-23 15:25:30 |
| maintainer | None |
| docs_url | None |
| author | Ken Kinder |
| requires_python | <4.0,>=3.9 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Brancher
Brancher is a tool inspired by git flow that is more flexible in how it handles branching. It allows any configuration of branches and simply makes it easier to see which commits are in what branch, as well as advancing changes between branches. A typical branch layout may be like this:
```
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
│ develop ├──▶│ staging ├──▶│ beta ├──▶│ master* │
└─────────────────┘ └─────────────────┘ └─────────────────┘ └─────────────────┘
*production branch
```
**Note**: Brancher can handle other configurations, assuming there's one final "production" branch and any number of sequential pre-production branches to the left of it.
## Installation
```shell
pip3 install gitbrancher
```
## Available Commands
Commands:
- overview (o): Prints an overview of branches with outstanding commits
- forward (f): Fast forwards commits into branch
- backfix (b): Applies changes on more advanced branches to current one
- compare (c): Shows commits in one branch but not another
- init: Initialize repo
Add `-h` to any command for usage details.
## Usage
### Initialization
Let's start with an example of an empty repo.
Next, initialize Brancher. Brancher will store your branching model in your repository's local configuration.
### Advancing commits
Now let's start some development work.
That looks good, so we'll advance that commit to `staging`, the next branch after `develop`.
While `staging` is having some Q/A work done, we'll continue development in `develop`:
### Commit overview
With pending commits in `develop` and `staging`, let's get an overview of what commits exist where.
### Backfilling hotfixes
With development work ongoing and Q/A happening on `staging`, let's make an urgent bugfix to production. As you can see, once that commit has been made, it only exists on the `master` branch, not other branches.
We want to bring that hotfix back into `develop`. After checking out `develop`, we'll apply the hotfix to develop too:
An overview confirms that the backfilled changes have been applied to `develop`, but not `beta` or `staging`:
We can remedy this by applying the hotfix to those environments, also:
Raw data
{
"_id": null,
"home_page": null,
"name": "gitbrancher",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Ken Kinder",
"author_email": "ken+github@kkinder.com",
"download_url": "https://files.pythonhosted.org/packages/8f/86/b642117ca6cc786243678d5e45f31d36705dda5a1b746375e4e151a97d34/gitbrancher-1.2.1.tar.gz",
"platform": null,
"description": "# Brancher\n\nBrancher is a tool inspired by git flow that is more flexible in how it handles branching. It allows any configuration of branches and simply makes it easier to see which commits are in what branch, as well as advancing changes between branches. A typical branch layout may be like this:\n\n```\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 develop \u251c\u2500\u2500\u25b6\u2502 staging \u251c\u2500\u2500\u25b6\u2502 beta \u251c\u2500\u2500\u25b6\u2502 master* \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n\n *production branch\n```\n\n**Note**: Brancher can handle other configurations, assuming there's one final \"production\" branch and any number of sequential pre-production branches to the left of it.\n\n## Installation\n\n```shell\npip3 install gitbrancher\n```\n\n## Available Commands\n\nCommands:\n\n- overview (o): Prints an overview of branches with outstanding commits\n- forward (f): Fast forwards commits into branch\n- backfix (b): Applies changes on more advanced branches to current one\n- compare (c): Shows commits in one branch but not another\n- init: Initialize repo\n\nAdd `-h` to any command for usage details.\n\n## Usage\n\n### Initialization\nLet's start with an example of an empty repo.\n\n\n\nNext, initialize Brancher. Brancher will store your branching model in your repository's local configuration.\n\n\n\n### Advancing commits\n\nNow let's start some development work.\n\n\n\nThat looks good, so we'll advance that commit to `staging`, the next branch after `develop`.\n\n\n\nWhile `staging` is having some Q/A work done, we'll continue development in `develop`:\n\n\n\n### Commit overview\n\nWith pending commits in `develop` and `staging`, let's get an overview of what commits exist where.\n\n\n\n### Backfilling hotfixes\n\nWith development work ongoing and Q/A happening on `staging`, let's make an urgent bugfix to production. As you can see, once that commit has been made, it only exists on the `master` branch, not other branches.\n\n\n\nWe want to bring that hotfix back into `develop`. After checking out `develop`, we'll apply the hotfix to develop too:\n\n\n\nAn overview confirms that the backfilled changes have been applied to `develop`, but not `beta` or `staging`:\n\n\n\nWe can remedy this by applying the hotfix to those environments, also:\n\n\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Manage git workflow between multiple branches",
"version": "1.2.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "20eab8ca65a798ea3c9f9af9e323cac37ed8c45e11724c59ec3d18e81b7a3dd8",
"md5": "d5240e4fa34c969a8644ed9fe6b4cd37",
"sha256": "f765cf0485cc9bb65cd95b929fbfabcc85d7de0900907dca88d99e7ee4fc3355"
},
"downloads": -1,
"filename": "gitbrancher-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d5240e4fa34c969a8644ed9fe6b4cd37",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 6182,
"upload_time": "2024-07-23T15:25:29",
"upload_time_iso_8601": "2024-07-23T15:25:29.035042Z",
"url": "https://files.pythonhosted.org/packages/20/ea/b8ca65a798ea3c9f9af9e323cac37ed8c45e11724c59ec3d18e81b7a3dd8/gitbrancher-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8f86b642117ca6cc786243678d5e45f31d36705dda5a1b746375e4e151a97d34",
"md5": "630beadefccc5a146a976e634e600ea0",
"sha256": "85024b51020893c6116c834cd02b98a0d28dcc82ebb7a73ba0b9921f6156d96d"
},
"downloads": -1,
"filename": "gitbrancher-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "630beadefccc5a146a976e634e600ea0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 5928,
"upload_time": "2024-07-23T15:25:30",
"upload_time_iso_8601": "2024-07-23T15:25:30.355202Z",
"url": "https://files.pythonhosted.org/packages/8f/86/b642117ca6cc786243678d5e45f31d36705dda5a1b746375e4e151a97d34/gitbrancher-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-23 15:25:30",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gitbrancher"
}
