debian-mirror-gitlab/doc/user/project/repository/branches/index.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

130 lines
5.5 KiB
Markdown
Raw Normal View History

2019-10-12 21:52:04 +05:30
---
2020-10-24 23:57:45 +05:30
stage: Create
group: Source Code
2022-11-25 23:54:43 +05:30
info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments"
2019-10-12 21:52:04 +05:30
---
2021-03-11 19:13:27 +05:30
# Branches **(FREE)**
2017-09-10 17:25:29 +05:30
2019-10-12 21:52:04 +05:30
A branch is a version of a project's working tree. You create a branch for each
set of related changes you make. This keeps each set of changes separate from
each other, allowing changes to be made in parallel, without affecting each
other.
After pushing your changes to a new branch, you can:
2022-11-25 23:54:43 +05:30
- Create a [merge request](../../merge_requests/index.md). You can streamline this process
by following [branch naming patterns](#naming).
- Perform inline code review.
- [Discuss](../../../discussions/index.md) your implementation with your team.
2019-10-12 21:52:04 +05:30
- Preview changes submitted to a new branch with [Review Apps](../../../../ci/review_apps/index.md).
2021-06-08 01:23:25 +05:30
You can also request [approval](../../merge_requests/approvals/index.md)
2021-04-29 21:17:54 +05:30
from your managers.
2019-10-12 21:52:04 +05:30
For more information on managing branches using the GitLab UI, see:
2021-04-29 21:17:54 +05:30
- [Default branches](default.md): When you create a new [project](../../index.md), GitLab creates a
default branch for the repository. You can change this setting at the project,
subgroup, group, or instance level.
2019-10-12 21:52:04 +05:30
- [Create a branch](../web_editor.md#create-a-new-branch)
- [Protected branches](../../protected_branches.md#protected-branches)
- [Delete merged branches](#delete-merged-branches)
- [Branch filter search box](#branch-filter-search-box)
You can also manage branches using the
[command line](../../../../gitlab-basics/start-using-git.md#create-a-branch).
2018-03-17 18:26:18 +05:30
2019-10-12 21:52:04 +05:30
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>Watch the video [GitLab Flow](https://www.youtube.com/watch?v=InKNIvky2KE).
2018-03-17 18:26:18 +05:30
See also:
2019-03-02 22:35:43 +05:30
- [Branches API](../../../../api/branches.md), for information on operating on repository branches using the GitLab API.
2021-06-08 01:23:25 +05:30
- [GitLab Flow](../../../../topics/gitlab_flow.md) documentation.
2019-03-02 22:35:43 +05:30
- [Getting started with Git](../../../../topics/git/index.md) and GitLab.
2018-03-17 18:26:18 +05:30
2022-11-25 23:54:43 +05:30
## Naming
Prefix a branch name with an issue number to streamline merge request creation.
When you create a merge request for a branch with a name beginning with an issue
number, GitLab:
- Marks the issue as related. If your project is configured with a
[default closing pattern](../../issues/managing_issues.md#default-closing-pattern),
merging this merge request [also closes](../../issues/managing_issues.md#closing-issues-automatically)
the related issue.
- Copies label and milestone metadata from the issue.
2019-10-12 21:52:04 +05:30
## Compare
To compare branches in a repository:
1. Navigate to your project's repository.
1. Select **Repository > Compare** in the sidebar.
2021-04-17 20:07:23 +05:30
1. Select the target repository to compare with the [repository filter search box](#repository-filter-search-box).
1. Select branches to compare using the [branch filter search box](#branch-filter-search-box).
2022-07-23 23:45:48 +05:30
1. Select **Compare** to view the changes inline:
2019-10-12 21:52:04 +05:30
2021-06-08 01:23:25 +05:30
![compare branches](img/compare_branches_v13_12.png)
2019-10-12 21:52:04 +05:30
2017-09-10 17:25:29 +05:30
## Delete merged branches
![Delete merged branches](img/delete_merged_branches.png)
This feature allows merged branches to be deleted in bulk. Only branches that
2022-10-11 01:57:18 +05:30
have been merged into the project's default branch and
[are not protected](../../protected_branches.md) are deleted as part of
2017-09-10 17:25:29 +05:30
this operation.
2018-03-17 18:26:18 +05:30
It's particularly useful to clean up old branches that were not deleted
2017-09-10 17:25:29 +05:30
automatically when a merge request was merged.
2021-04-17 20:07:23 +05:30
## Repository filter search box
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/52967) in GitLab 13.10.
This feature allows you to search and select a repository quickly when [comparing branches](#compare).
2021-06-08 01:23:25 +05:30
![Repository filter search box](img/repository_filter_search_box_v13_12.png)
2021-04-17 20:07:23 +05:30
Search results appear in the following order:
- Repositories with names exactly matching the search terms.
- Other repositories with names that include search terms, sorted alphabetically.
2018-12-13 13:39:08 +05:30
## Branch filter search box
2021-06-08 01:23:25 +05:30
![Branch filter search box](img/branch_filter_search_box_v13_12.png)
2018-12-13 13:39:08 +05:30
This feature allows you to search and select branches quickly. Search results appear in the following order:
- Branches with names that matched search terms exactly.
- Other branches with names that include search terms, sorted alphabetically.
Sometimes when you have hundreds of branches you may want a more flexible matching pattern. In such cases you can use the following:
2021-04-17 20:07:23 +05:30
- `^feature` matches only branch names that begin with 'feature'.
- `feature$` matches only branch names that end with 'feature'.
2019-10-12 21:52:04 +05:30
2021-06-08 01:23:25 +05:30
## Swap revisions
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/60491) in GitLab 13.12.
![Before swap revisions](img/swap_revisions_before_v13_12.png)
2022-11-25 23:54:43 +05:30
The Swap revisions feature allows you to swap the Source and Target revisions. When the Swap revisions button is selected, the selected revisions for Source and Target is swapped.
2021-06-08 01:23:25 +05:30
![After swap revisions](img/swap_revisions_after_v13_12.png)
2019-10-12 21:52:04 +05:30
<!-- ## 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. -->