gitlab-org--gitlab-foss/doc/university/training/gitlab_flow.md

55 lines
1.7 KiB
Markdown
Raw Normal View History

2017-11-01 11:56:40 -04:00
---
comments: false
type: reference
2017-11-01 11:56:40 -04:00
---
2018-05-09 12:11:28 -04:00
# What is the GitLab Flow
2016-10-20 06:38:32 -04:00
- A simplified branching strategy
- All features and fixes first go to master
- Allows for 'production' or 'stable' branches
- Bug fixes/hot fix patches are cherry-picked from master
2018-05-09 12:11:28 -04:00
## Feature branches
2016-10-20 06:38:32 -04:00
- Create a feature/bugfix branch to do all work
- Use merge requests to merge to master
![inline](gitlab_flow/feature_branches.png)
2018-05-09 12:11:28 -04:00
## Production branch
2016-10-20 06:38:32 -04:00
- One, long-running production release branch
as opposed to individual stable branches
- Consider creating a tag for each version that gets deployed
![inline](gitlab_flow/production_branch.png)
2018-05-09 12:11:28 -04:00
## Release branch
2016-10-20 06:38:32 -04:00
- Useful if you release software to customers
- When preparing a new release, create stable branch
from master
- Consider creating a tag for each version
- Cherry-pick critical bug fixes to stable branch for patch release
- Never commit bug fixes directly to stable branch
![inline](gitlab_flow/release_branches.png)
2018-05-09 12:11:28 -04:00
## More details
2016-10-20 06:38:32 -04:00
For more information, read through the [GitLab Flow](../../topics/gitlab_flow.md)
2018-05-09 12:11:28 -04:00
documentation.
<!-- ## Troubleshooting
Include any troubleshooting steps that you can foresee. If you know beforehand what issues
one might have when setting this up, or when something is changed, or on upgrading, it's
important to describe those, too. Think of things that may go wrong and include them here.
This is important to minimize requests for support, and to avoid doc comments with
questions that you know someone might ask.
Each scenario can be a third-level heading, e.g. `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place
but commented out to help encourage others to add to it in the future. -->