A git extension which provides commands for working according Git-Flow easily & safely in your repository.
Project description
GitHub-Flow (git flow
)
git flow
is a GitHub CLI extention. It provides commands for working easily and safely according the Git-Flow.
GitHub-Flow extention is available for anyone who wants to work according the Git flow easily and safely. Through GitHub-Flow, you will be able to assimilate and enforce the Git-Flow in your team without the need for learning or mistakes along the workflow.
Documentation
[See the manual][manual] for setup and usage instructions.
Installation
pip install github-flow
Configuration (github-flow.yaml)
The main advantage of this git-flow implementation (additional to the pull-reuests before the merge), is the centralized configuration file, all the developers workflow will be the same according this conf file.
This conf file is required, please add it to the root directory of your repository before starting work with git flow
.
---
branch:
feature_branch_prefix: feature/
hotfix_branch_prefix: hotfix/
release_branch_prefix: release/
released_branch: main
next_release_branch: develop
release:
create_release: true
release_notes_file: changelog.md #OPTIONAL
pull-request:
merge_mode: squash
- create_release - if you want to bump version (according SemVer.org) and create a tag automatically - set
true
. - release_notes_file - Remove this line from the conf file if you don't have a changelog/release-notes file.
- merge_mode - The merge mode that will be used in your workflow.
- merge - Merge the commits with the base branch
- rebase - Rebase the commits onto the base branch
- squash - Squash the commits into one commit and merge it into the base branch
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for github_flow-0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 825a1a2e0048313958dcef093f6a1e18b29183700b1f23e91ec1a05e4aeddba6 |
|
MD5 | d8d4d142595e545854ac15c23dd20d95 |
|
BLAKE2b-256 | d575d4dc59de51580bcc7db79fc9335b6e116f8be787b8be35c4953d860312a7 |