Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kasuken/git-flow-cheatsheet
yet another GitFlow cheatsheet.
https://github.com/kasuken/git-flow-cheatsheet
git gitflow
Last synced: 3 months ago
JSON representation
yet another GitFlow cheatsheet.
- Host: GitHub
- URL: https://github.com/kasuken/git-flow-cheatsheet
- Owner: kasuken
- License: mit
- Created: 2023-09-13T08:42:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-15T05:43:41.000Z (over 1 year ago)
- Last Synced: 2024-03-17T17:47:46.253Z (10 months ago)
- Topics: git, gitflow
- Homepage:
- Size: 10.7 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitFlow Cheatsheet
image by Atlassian
## Overview
GitFlow is a workflow that defines a strict branching structure and a set of rules for merging changes between branches. It is based on two main branches: master and develop.
- **master**: This branch contains the production-ready code. It is updated only when a new release is ready to be deployed.
- **develop**: This branch contains the latest features and bug fixes that are being worked on. It is updated regularly by merging feature branches into it.
In addition to these two main branches, GitFlow uses four types of supporting branches: feature, release, hotfix, and support.
- **feature**: These branches are created from develop and merged back into develop when a feature is completed. They are used to implement new functionality or enhancements. They have names like feature/xxx, where xxx is a descriptive name of the feature.
- **release**: These branches are created from develop and merged into master and develop when a release is ready to be deployed. They are used to prepare the code for production, such as fixing bugs, updating documentation, and changing configuration. They have names like release/x.y.z, where x.y.z is the version number of the release.
- **hotfix**: These branches are created from master and merged into master and develop when a critical bug needs to be fixed in production. They are used to patch the code without affecting the ongoing development. They have names like hotfix/x.y.z, where x.y.z is the version number of the hotfix.
## Commands
The following commands are examples of how to use GitFlow. You can also use a graphical tool or a plugin to manage GitFlow.
### Initialize GitFlow
To start using GitFlow, you need to initialize it in your repository. This will create the master and develop branches and set some configuration options.
```bash
git flow init
```
You can use the `-d` option to accept the default branch names.
### Start a feature branch
To start working on a new feature, you need to create a feature branch from develop.
```bash
git flow feature start
```
This will create a branch called feature/name and switch to it.
### Finish a feature branch
When you are done with your feature, you need to merge it back into develop and delete the feature branch.
```bash
git flow feature finish
```
This will merge feature/name into develop, switch to develop, and delete feature/name.
### Start a release branch
When you are ready to prepare a new release, you need to create a release branch from develop.
```bash
git flow release start
```
This will create a branch called release/version and switch to it.
### Finish a release branch
When you have finished testing and fixing your release, you need to merge it into master and develop and tag it with the version number.
```bash
git flow release finish
```
This will merge release/version into master and develop, switch to master, tag it with , switch back to develop, and delete release/version.
**Important**: if you want to tag the release directly from the command, add the parameter -m at the end of the command.
```bash
git flow release finish -m
```
### Start a hotfix branch
When you need to fix a critical bug in production, you need to create a hotfix branch from master.
```bash
git flow hotfix start
```
This will create a branch called hotfix/version and switch to it.
### Finish a hotfix branch
When you have fixed the bug, you need to merge it into master and develop and tag it with the version number.
```bash
git flow hotfix finish
```
This will merge hotfix/version into master and develop, switch to master, tag it with , switch back to develop, and delete hotfix/version.