プラン ブランチの使用

このページの内容

このセクションの項目

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

計画ブランチは、バージョン管理リポジトリ内のブランチを表すために使用します。計画ブランチでは、計画と同じビルド設定が使用されます。

Tools such as Git and Mercurial encourage a practice called feature branching, where a developer can use a new branch to work in isolation from his or her team members before merging their changes back into main line development.

With plan branches in Bamboo:

  • リポジトリで新規作成されたブランチは、親計画と同じビルド設定を使用して自動でビルドおよびテストされます。 
  • Any branches deleted from the repository can be deleted automatically from Bamboo according to the settings.
  • 必要に応じて、親計画を上書きしてブランチ計画を個別に設定できる柔軟性があります。
  • オプションで、ビルドが成功した場合にフィーチャー ブランチからの変更を「master」(トランク ブランチ、既定のブランチ、メインライン ブランチなど) に自動でマージすることもできます。

You can customize how Bamboo manages branches on the system, plan, and branch levels. 

Further reading:


Managing plan branches in Bamboo

You can create plan branches manually or automatically. The branch configuration can be provided on the plan level and customized on the branch level. The settings provided in the branch configuration override the settings provided for the plan.

tip/resting Created with Sketch.

Use the Branch status page for quick access to plan branch information.

You can access the list of all branches in a plan from different places. For example, you can click the Branch iconnext to the plan name in the Build Dashboard  view:


You can also access the branch list from the Plan summary view:

Subversion branches location

This section is displayed only for plans that use a Subversion source repository. Bamboo assumes that your Subversion repository structure follows the convention for branches, and automatically calculates the branch root URL.

For example, for the fastBuild repo with this URL: https://svn.mycompany.com/svn/fastBuild/trunk Bamboo will expect that branches will be created at this location: https://svn.mycompany.com/svn/fastBuild/branches 

If your Subversion repository structure follows a different convention, you can specify where repository branches will be created by selecting Change subversion branches URL.

Automatic branch management

Plan branches can be created and deleted automatically based on the updates in the primary source repository. Automatic branch management is available for Git, Mercurial, and Subversion. For other repository types, you can use manual branching. You can override the default settings for a branch, such as values of the variables.

By default, automatic branch management is:

  • disabled for branches that you create manually
  • enabled for branches that are created automatically

You can specify how often Bamboo checks the primary source repository for new or deleted branches in the general branch settings.

You can override the branch deletion settings in the branch details configuration view.

To hand over the branch management to Bamboo:

  1. Go to the Plan Configuration view: in the Plan summary view, click the  Actions  button   and select Configure plan
  2. Click the Branches tab.
    1.  Configure the following:

      操作Primary source repository branches説明 コメント

      Create plan branch


      手動

      Bamboo doesn't create new plan branches automatically. You can create branches manually.
      When pull request is createdBamboo creates a plan branch automatically when a new pull request is created. If a pull request is merged or declined, Bamboo will disable this plan branch. Note that this option is available for environment that provide support for pull requests. Currently, these are Bitbucket Server, and Bitbucket Cloud.
      Bamboo creates a plan branch for each new branch detected in the primary source repository.
      Bamboo creates a plan branch for each new branch detected in the primary source repository that matches the regular expression that you provided.
      Delete plan branchAfter branch was deleted from repository

      When a branch is deleted from the repository, Bamboo will wait for provided number of days before deleting the plan branch.

      If you selected Clean up plan branch automatically in the configuration on the branch level, the branch is disabled and deleted according to the daily cleanup rules, regardless of the automatic branch management settings. Clean up plan branch automatically is selected by default for manually created "Plan Branches".
      After branch inactivity in repositoryWhen a branch is inactive for provided number of days, Bamboo will delete the plan branch.

      If a branch in the primary source repository is inactive, Bamboo does not automatically delete the corresponding plan branch.

  3. Click Save at the bottom of the view to apply the changes.


Global settings - branch detection interval

Once plan branching is enabled, Bamboo checks for new or deleted branches in the primary source code repository.

You can specify how often Bamboo checks for new branches in the primary source repository in the system settings. The default value is 300 seconds.

To configure the branch detection interval:

  1. Open the Bamboo Administration view by clicking the cog icon  and selecting a section from the list that opens.
  2. In the Bamboo Administration view, scroll down the menu on the left to find the System section.
  3. Click General configuration.
  4. In Global system configurations, set the branch detection interval. Provide the value in seconds, the default value is 300.

Manual branch management

Use manual branching for all supported repository types. You may want to consider using automatic branch management for Git, Mercurial and Subversion repositories.

計画のブランチを手動で作成するには、次の手順を実行します。

  1. Go to the Plan Configuration view: in the Plan summary view, click the Actions button  and select Configure plan
  2. Click the Branches tab.
  3. Click Create plan branch in the upper right of the view.
  4. In the Create plan branch view, you can create branches in one of the following ways:

    操作説明
    Select from available VCS branches

    Select one or more branches from the list of available VCS branches.

    At the bottom of the list of the branches you can select the Enable branches check box, which makes all selected branches available for building and change detection.

    Create plan branch manually

    Provide:

    • a display name (required) - overrides the VCS branch name
    • a branch description - a meaningful description of the branch
    • VCS branch name - the name of the branch in the VCS repository

    You can select the Enable branches check box, which makes the new branch available for building and change detection.

    Click Auto-detect VCS branches to go back to the list of available VCS branches.

  5. 保存をクリックします。

Integrating branches with Jira applications

Check Create Remote Links from Jira Issues to have the plan branch automatically linked, using an issue key in the branch name. 

When a developer begins working on a feature described in a Jira application issue, they use Git or Mercurial to branch the repository. If they use the issue key as part of the VCS branch name, Bamboo will detect the issue key and automatically link the new branch to the issue:

  • The Jira application issue key needs to be in the name of the branch – 'jb-BDEV-790' and ' BDEV-769 1 ' are valid forms.
  • The link shows up right under the breadcrumb on the Build Result Summary for the plan branch, and on the issue too.

To use Jira applications Feature Branching, Bamboo needs an application link to the Jira application server.


Branch repositories

Once the plan branch is created, automatically or manually, all repositories defined in the plan inherit settings from the master plan by default. The only exception is the default repository, which uses one of the following branches:

  • branch selected by you during the manual creation of the plan, 
  • branch detected in VCS in case of automatically created plan.

You can change settings of all repositories defined in the plan branch in the Repositories tab. In this tab, simply put a desired branch name or enable the Change repository settings for this branch plan toggle if you need to modify more settings.

In the Branch summary tab the Repository branches section gives you a quick overview of repositories and branches configured in the plan branch. The Default repository settings changed flag indicates that this repository overrides more settings from the parent plan. The No branch support flag means that a given repository type does not support branches. 


ブランチの通知

master 計画の場合と同じように、ブランチ計画からビルド通知を受け取ることができます。

To specify how notifications are sent by all branches created from a plan, go to the Branches tab for the plan's configuration and choose one of the following options:

  • コミッターやこのブランチをお気に入りに登録したユーザーに通知する。
  • 計画の通知設定を使用する。
  • このブランチでは通知を送信しない。

You can override how notifications are sent from a particular branch plan, if necessary, by going to the Notifications tab on the Plan Branch configuration.

See Configuring notifications for a plan and its jobs for information about plan notifications.

ブランチの依存関係

You can use build dependencies for plan branches in a similar way to that for plans: a branch plan is triggered only when another branch plan has been successfully built. This can be used to ensure that breaking source code changes associated with one branch plan are detected before they can break the build of a dependent branch plan. Dependencies between master plans are maintained if their branch plans have the same name. See Setting up plan build dependenciesfor further information about dependencies.

Select Trigger Dependencies for Branches, on the Dependencies tab for the plan configuration, if you want plan branches to honor the build dependencies of their respective master plans.

Branch details configuration

計画ブランチの作成が自動か手動かにかかわらず、master 計画はそのブランチ計画の構造と構成を管理します。ただし、設定ページに移動して、ブランチ計画の次の設定を上書きすることはできます。

Branch clean-up (ブランチのクリーンアップ)

On the Branch Details tab of the branch's configuration, you can specify that a plan branch is not cleaned up automatically.

(info) Please note that 'Automatic Branch Clean-up' is supported for Mercurial, Git (Bamboo 4.1.1 and above) and Subversion (Bamboo 4.2.0 and above).

By default, plan branches are deleted automatically after:

  • 7 days after the branch was deleted in the primary source repository OR
  • 10 days of branch inactivity in the primary source repository 

The values can be specified on the plan level.

トリガーのタイプ

On the Branch Details tab of the branch's configuration. See Triggering builds.

1 つの計画ブランチに設定できるトリガーは 1 つだけであり、これは master 計画に設定されるすべてのトリガーよりも優先されることにご注意ください。

マージ

On the Branch Details tab of the branch's configuration. Described below.


ソース リポジトリ

On the Source Repository tab of the plan branch configuration. You can override the default repository settings of a plan on the branch level:

通知

On the Notifications tab of the branch's configuration. The options are:

  • コミッターやこのブランチをお気に入りに登録したユーザーに通知する。
  • 計画の通知設定を使用する。
  • このブランチでは通知を送信しない。

See Configuring notifications for a plan and its jobs for information about plan notifications.

Variables

On the Variables tab of the branch's configuration. See Defining plan variables.


Automatic branch merging

ブランチのマージを自動化する場合、Bamboo には 2 つのマージ モデルが用意されています。

  • Branch Updater — a branch repo is kept up-to-date with changes to master. Note that changes on your master branch do not trigger branch builds.
  • Gatekeeper — the default repo is only updated with changes in the branch that have built successfully.

The automatic branch merge strategy for the master plan can be overridden in an individual plan branch, if required. Automatic branch merging is not available for Subversion.


ブランチ アップデーター

使用環境

ブランチ アップデーターは、次のような場合に使用してください。

  • Automatically merge changes from the team's master branch into your feature branch, after a successful build of the master and branch merge.
  • フィーチャー ブランチの変更がチームの master ブランチに対応しなくなった際に通知を受け取ります。

Change detection is available only for the branch you're currently working on.


設定

別のリポジトリの最近の変更をブランチ リポジトリに統合するには、次の手順を実行します。

  1. Go to the Branch Details tab of the branch plan's configuration pages. 
    (Click on the branch icon beside a plan name on the All Plans tab, then choose Actions > Configure Branch.)
  2. Under 'Merging' select Branch Merging Enabled, and then click Branch Updater.
  3. Use the Merge From list to choose the repo from which changes should be merged with your feature branch.
  4. Select Push on only if you want those changes merged back into your branch once the build completes successfully,
  5. 保存をクリックします。

Gatekeeper

使用環境

ゲートキーパーは、次のような場合に使用してください。

  • 両方のブランチからマージされた変更が正常にビルドされた後、フィーチャー ブランチをチームの master ブランチに自動でマージします。
  • 両方のブランチから結合された変更のビルドが失敗した際に通知を受け取り、フィーチャー ブランチがチームの master ブランチに再マージされないようにします。

設定

正常にビルドされた変更を別のリポジトリにプッシュするには、次の手順を実行します。

  1. Go to the Branch Details tab of the branch plan's configuration pages. 
    (Click on the branch icon beside a plan name on the All Plans tab, then choose Actions > Configure Branch.)
  2. Under 'Merging' select Branch Merging Enabled, and then click Gate Keeper.
  3. Use the Checkout list to choose the repo with which to merge your changes (and to which changes should be pushed).
  4. Select Push on only if you want your changes pushed to the other repo once the build completes successfully,
  5. 保存をクリックします。

計画ブランチの制限事項

計画の自動ブランチングおよびマージには、次の制限が適用されます。

操作制限事項
計画の自動ブランチング
  • Git、Mercurial、および Subversion リポジトリでのみ使用できます。他のリポジトリ タイプでは、手動ブランチングを使用してください。
  • Cannot be used with the Git implementation embedded in Bamboo. (You need to have set up native Git.)

計画の手動ブランチング

  • Bamboo でサポートされているすべてのリポジトリ タイプで使用できます。
ブランチの自動マージ
  • Git および Mercurial リポジトリでのみ使用できます。
  • Bamboo で設定されたブランチでのみ使用できます。
  • Cannot be used with the Git implementation embedded in Bamboo. (You need to have set up native Git.)

ブランチ ウォールボード

The branches wallboard displays the status of all the branches and the plan that the branches belong to. The plan's own status always appears first. Plans shown as grey are disabled.

ブランチ ウォールボードを表示するには、次の手順を実行します。

  1. 表示するブランチがある計画の [Plan Summary (計画の要約)] に移動します。
  2. Choose Actions > Branch Wallboard.

最終更新日: 2018 年 10 月 19 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する

このセクションの項目

Powered by Confluence and Scroll Viewport.