ブランチ

ブランチはプロジェクトの作業ツリーのバージョンです。新しいプロジェクトを作成すると、GitLabはリポジトリ用のデフォルトブランチ（削除不可）を作成します。デフォルトブランチの設定は、プロジェクト、サブグループ、グループ、インスタンスレベルで設定できます。

プロジェクトが大きくなるにつれて、チームはより多くのブランチを作成し、できればブランチの命名パターンに従います。各ブランチは一連の変更を表し、開発作業を並行して行うことができます。あるブランチでの開発作業が、別のブランチに影響することはありません。

ブランチは、プロジェクトにおける開発の基盤です：

  1. まずブランチを作成し、そこにコミットを追加します。
  2. 作業がレビューできる状態になったら、マージリクエストを作成してブランチの変更をマージします。この作業を効率化するために、ブランチの命名パターンに従うようにしましょう。
  3. レビューアプリでブランチの変更をプレビューします。
  4. ブランチの内容がマージされたら、マージしたブランチを削除します。

ブランチの作成

前提条件：

  • 少なくともプロジェクトの開発者ロールを持っている必要があります。

GitLab UI から新しいブランチを作成するには：

  1. 左のサイドバーで「検索」または「移動」を選択してあなたのプロジェクトを検索します。
  2. コード > ブランチを選択します。
  3. 右上の [新規ブランチ] を選択します。
  4. ブランチ名を入力します。
  5. ブランチの作成元で、既存のブランチ、既存のタグ、コミット SHA のいずれかを選択します。
  6. ブランチを作成 を選択します。

空白のプロジェクトで

空白のプロジェクトにはブランチはありませんが、ブランチを追加することはできます。

前提条件：

  • 少なくともプロジェクトの開発者ロールを持っている必要があります。
  • メンテナーやオーナーのロールがない場合、デフォルトブランチにコミットをプッシュするには、デフォルトブランチの保護をPartially protected あるいはNot protected に設定しなければなりません。

空のプロジェクトにデフォルトブランチを追加するには

  1. 左のサイドバーで「検索」または「移動」を選択してあなたのプロジェクトを検索します。
  2. The repository for this project is emptyまでスクロールし、追加したいファイルの種類を選択します。
  3. Web IDE で、このファイルに必要な変更を加え、コミットの作成を選択します。
  4. コミットメッセージを入力し、コミットを選択します。

GitLab はデフォルトブランチを作成し、あなたのファイルをそこに追加します。

イシューから

前提条件：

  • 少なくともプロジェクトの開発者ロールを持っている必要があります。

イシューを表示しているときに、そのページから直接関連ブランチを作成することができます。この方法で作成したブランチは、変数を含むイシューからのブランチ名のデフォルトパターンを使用します。

前提条件：

  • 少なくともプロジェクトの開発者ロールを持っている必要があります。

イシューからブランチを作成するには

  1. 左のサイドバーで「検索」または「移動」を選択してあなたのプロジェクトを検索します。
  2. プラン > イシューを選択し、課題を見つけます。
  3. issueの説明の下にある[マージリクエストを作成]ドロップダウンリストを探し、{chevron-down}を選択してドロップダウンリストを表示します。
  4. ブランチの作成]を選択します。このプロジェクトのデフォルトパターンに基づいて、デフォルトのブランチ名が提供されます。必要に応じて、別のブランチ名を入力してください。
  5. Create branchを選択すると、プロジェクトのデフォルトブランチに基づいてブランチが作成されます。

ブランチの管理と保護

GitLabは個々のブランチを保護するための複数の方法を提供します。これらの方法は、ブランチの作成から削除まで、ブランチが監視と品質チェックを受けることを保証します：

ブランチを管理できます：

すべてのブランチを表示

GitLabユーザーインターフェイスでブランチを表示・管理するには：

  1. 左のサイドバーで「検索」または「移動」を選択してあなたのプロジェクトを検索します。
  2. コード > ブランチを選択します。

このページでは、次のことができます：

  • すべてのブランチを表示、またはフィルタリングしてアクティビティや古いブランチのみを表示。
  • 新しいブランチを作成します。
  • ブランチを比較します。
  • マージしたブランチを削除します。

設定された保護を持つブランチの表示

フラグ: セルフマネジメントのGitLabでは、デフォルトでこの機能が利用可能です。この機能を隠すには、管理者がbranch_rules という機能フラグを無効にします。GitLab.comでは、この機能は利用可能です。

リポジトリ内のブランチは、複数の方法で保護できます。できます：

  • ブランチにプッシュできる人を制限します。
  • ブランチをマージできる人を制限します。
  • すべての変更に対して承認者を必要とします。
  • 外部テストの合格を要求。

ブランチルールの概要ページには、保護が設定されているすべてのブランチと、その保護方法が表示されます：

Example of a branch with configured protections

前提条件：

  • 少なくともプロジェクトのメンテナーのロールを持っている必要があります。

ブランチルールの概要リストを表示します：

  1. 左のサイドバーで「検索」または「移動」を選択してあなたのプロジェクトを検索します。
  2. 設定] > [リポジトリ]を選択します。
  3. ブランチルールを展開し、保護機能を持つすべてのブランチを表示します。
    • 新しいブランチに保護を追加するには
      1. ブランチルールの追加を選択します。
      2. 保護ブランチの作成]を選択します。
    • 既存のブランチの保護に関する詳細情報を表示するには：
      1. 詳細情報が必要なブランチを特定します。
      2. 詳細を見る]を選択すると、支店の情報が表示されます：

ブランチ名

Git はブランチ名のルールを強制することで、他のツールとのブランチ名の互換性を保ちます。GitLabはブランチ名に特別な要件を追加し、適切に構造化されたブランチ名にメリットをもたらします。

GitLabはすべてのブランチに対してこれらの追加ルールを強制します：

  • ブランチ名にはスペースを使用できません。
  • Git のコミットハッシュに似ているので、16 進数 40 文字のブランチ名は使用できません。

Docker のような一般的なソフトウェアパッケージでは、ブランチの名前にさらなる制限をかけることができます。

他のソフトウェアパッケージとの互換性を高めるには、以下のようにします：

  • 数字
  • ハイフン (-)
  • アンダースコア (_)
  • ASCII標準表にある小文字

ブランチ名にはスラッシュ (/) や絵文字を使用できますが、他のソフトウェアパッケージとの互換性は保証されません。

特定の書式を持つブランチ名には、さらに利点があります：

イシューからのブランチ名のデフォルトパターンの設定

デフォルトでは、GitLab はイシューからブランチを作成するときに%{id}-%{title} というパターンを使いますが、このパターンは変更することができます。

前提条件：

  • 少なくともプロジェクトのメンテナーのロールを持っている必要があります。

イシューから作成されるブランチのデフォルトパターンを変更するには、次のようにします：

  1. 左のサイドバーで「検索」または「移動」を選択してあなたのプロジェクトを検索します。
  2. 設定] > [リポジトリ]を選択します。
  3. ブランチのデフォルトを展開します。
  4. ブランチ名テンプレートまでスクロールし、値を入力します。このフィールドは以下の変数に対応しています：
    • %{id}:イシューの数値ID。
    • %{title}:イシューのタイトル。Gitブランチ名で使用可能な文字のみを使用するように変更されています。
  5. 変更を保存を選択します。

ブランチ名の前にイシュー番号を付けます。

マージリクエストの作成を効率化するには、ブランチ名の先頭にイシュー番号をつけましょう。GitLab はこのイシュー番号を使ってマージリクエストにデータをインポートします：

  • イシューはマージリクエストに関連するものとしてマークされます。イシューとマージリクエストはお互いにリンクを表示します。
  • ブランチはイシューに接続されています。
  • プロジェクトにデフォルトのクローズパターンが設定されている場合、マージリクエストをマージすると、関連するイシューもクローズされます。
  • イシューのマイルストーンとラベルはマージリクエストにコピーされます。

ブランチの比較

リポジトリ内のブランチを比較します：

  1. 左のサイドバーで「検索」または「移動」を選択してあなたのプロジェクトを検索します。
  2. コード > リビジョンを比較]を選択します。
  3. ソースブランチを選択して、目的のブランチを検索します。完全に一致するものが最初に表示されます。オペレーターで検索を絞り込むことができます：
    • ^ はブランチ名の先頭にマッチします:^feat はfeat/user-authenticationにマッチします。
    • $ はブランチ名の最後にマッチします:widget$ はfeat/search-box-widgetにマッチします。
    • * はワイルドカードを使ってマッチします:branch*cache* はfix/branch-search-cache-expirationにマッチします。
    • ^chore/*migration$ はchore/user-data-migration にマッチします。
  4. 対象のリポジトリとブランチを選択します。完全一致が最初に表示されます。
  5. 変更を表示 の下で、ブランチを比較する方法を選択します：
    • ソースからの変更のみ(デフォルト) は、両ブランチ共通の最新のコミット以降のソースブランチとの差分を表示します。ソースブランチが作成された後にターゲットブランチに加えられた無関係な変更は含まれません。この方式では、git diff <from>...<to> Git コマンドを使用します。ブランチを比較する際に実際のコミットではなくマージベースを使用するので、cherry-pick されたコミットからの変更が新しい変更として表示されます。
    • ソースが作成されてからのターゲットへの変更を含めると、2 つのブランチ間のすべての差分が表示されます。この方法では、git diff <from> <to> Git コマンドを使用します。
  6. Compareを選択すると、コミットの一覧と変更されたファイルが表示されます。
  7. オプションです。ソースと ターゲットを逆にするには、リビジョンを入れ替える（{substitute}）を選択します。

マージブランチを削除

マージされたブランチは、以下の条件をすべて満たせば、一括で削除することができます：

  • 保護されたブランチでないこと。
  • これらはプロジェクトのデフォルトブランチにマージされています。

前提条件：

  • 少なくともプロジェクトの開発者ロールを持っている必要があります。

そのためには

  1. 左のサイドバーで「検索」または「移動」を選択してあなたのプロジェクトを検索します。
  2. コード > ブランチを選択します。
  3. ページの右上で、[More ]を選択します。
  4. マージされたブランチを削除]を選択します。
  5. ダイアログで、delete と入力して確認し、Delete merged branches を選択します。

トラブルシューティング

同じコミットを含む複数のブランチ

より深い技術的なレベルでは、Git のブランチは独立したものではなく、コミット SHA のセットに付けられたラベルです。GitLab はブランチがマージされたかどうかを判断する際に、ターゲットブランチにコミット SHA があるかどうかを調べます。この動作は、二つのマージリクエストに同じコミットが含まれている場合に予期せぬ結果を引き起こすことがあります。この例では、ブランチB とC はどちらもブランチA の同じコミット (3) から始まっています：

gitGraph commit id:"a" branch "branch A" commit id:"b" commit id:"c" type: HIGHLIGHT branch "branch B" commit id:"d" checkout "branch A" branch "branch C" commit id:"e" checkout main merge "branch B" id:"merges commits b, c, d"

ブランチB をマージすると、ブランチのA すべてのコミットが Aターゲットブランチmainに現れるので、A ブランチもマージされたように見えます (何もアクションを起こさなくても) A。ブランチC はマージされないままです。これは、コミット5 がブランチA やBの一部ではなかったからです。

マージリクエストはA 、そのブランチに新しいコミットをプッシュしようとしてもマージされたまま Aです。A マージリクエストの A変更がマージされずに残っているA 場合 A(マージリクエストAに含まれていなかったため)、その変更のために新しいマージリクエストを開いてください。

エラー: あいまいなHEAD ブランチが存在します。

Git 2.16.0 より前のバージョンでは、HEADというブランチを作成することができました。このブランチ名は、Git がアクティブな (チェックアウトされた) ブランチを表すために使うHEAD 内部参照 (この名前も HEAD同様です)HEAD と衝突 HEADします。この名前の衝突によって、リポジトリのデフォルトブランチを更新できなくなることがあります：

Error: Could not set the default branch. Do you have a branch named 'HEAD' in your repository?

この問題を解決するには

  1. 左のサイドバーで「検索」または「移動」を選択してあなたのプロジェクトを検索します。
  2. コード > ブランチを選択します。
  3. HEAD というブランチを検索します。
  4. ブランチにコミットされていない変更がないことを確認してください。
  5. ブランチを削除する を選択し、はい、ブランチを削除します。

Git バージョン2.16.0 以降では、この名前でブランチを作成することはできません。