スケジュールされたパイプラインと、手動でトリガーされたパイプライン

Bitbucket を使用すると、複数のパイプラインを手動でトリガーするか、特定の時間にトリガーをスケジュールすることで、複数のパイプラインを実行できます。

概要

パイプライン ステップを手動で実行する

手動ステップにより、手動でトリガーされたときにのみ実行されるステップを構成して、CI/CD パイプラインをカスタマイズできます。これは、ステップの実行前に手動でのテストやチェックが必要になる、デプロイ ステップなどの項目で便利です。

手動ステップを定義するには、bitbucket-pipelines.yml ファイルのステップに trigger: manual  を追加します。

パイプラインはコミットでトリガーするため、最初のステップを手動にすることはできません。パイプラインを手動でのみ実行したい場合、カスタム パイプラインをセットアップできます。カスタム パイプラインのもう 1 つのメリットは、変数の値を一時的に追加または更新できる点です。バージョン番号を追加したり、1 回のみ使用する値を提供したりするために使用できます。

手動パイプラインを設定する

特定のコミットに対して既存のパイプラインを手動で実行したり、既存のパイプラインをスケジュールされたビルドとして手動で実行したりすることができます。

パイプラインを手動でのみ実行したい場合、カスタム パイプラインを使用します。カスタム パイプラインは、ブランチへのコミットでは自動的に実行されません。カスタム パイプラインを定義するには、bitbucket-pipelines.yml ファイルの  custom  セクションにパイプライン構成を追加します。カスタム パイプラインとして定義されていないパイプラインは、ブランチへのプッシュが発生したときに自動的に実行されます。

パイプラインを手動で実行し、Bitbucket Cloud UI からトリガーするには、リポジトリでの書き込み権限が必要です。

セットアップ

  1. bitbucket-pipelines.yml ファイルにパイプラインを追加します。bitbucket-pipelines.yml ファイルに含まれるパイプライン ビルド構成のビルドを手動でトリガーできます。
    例:

    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 pipelines: custom: # Pipelines that can only be triggered manually sonar: - step: script: - echo "Manual triggers for Sonar are awesome!" deployment-to-prod: - step: script: - echo "Manual triggers for deployments are awesome!" branches: # Pipelines that run automatically on a commit to a branch can also be triggered manually staging: - step: script: - echo "Automated pipelines are cool too."
  2. Bitbucket Cloud からパイプラインをトリガーします。パイプラインは、Bitbucket Cloud のブランチ ビューまたはコミット ビューから手動でトリガーできます。

ブランチ ビューからパイプラインを手動で実行する

  1. Bitbucket でリポジトリを選択し、[ブランチ] に移動します。

  2. パイプラインを実行するブランチを選択します。

  3. (...) をクリックし、[ブランチでパイプラインを実行] をクリックします。

  4. パイプラインを選択して [実行] をクリックします。

コミット ビューからパイプラインを手動で実行する

  1. Bitbucket でリポジトリを選択し、[コミット] に移動します。

  2. コミット ビューに移動してコミットを表示します。

  3. コミット ハッシュを選択します。

  4. [パイプラインの実行] を選択します。

  5. パイプラインを選択して [実行] をクリックします。

Pipelines ページからパイプラインを手動で実行

  1. Bitbucket でリポジトリを選択し、[Pipelines] に移動します。

  2. [パイプラインの実行] をクリックします。

  3. ブランチ、パイプラインを選択して [実行] をクリックします。

さらに、カスタム パイプラインを実行して、パイプラインに変数を手動でパースできます。
変数を有効化するには、パイプラインを実行するときに入力するカスタム パイプラインの下に変数を定義します。

例:

1 2 3 4 5 6 7 8 9 10 pipelines: custom: custom-name-and-region: #name of this pipeline - variables: #list variable names under here - name: Username - name: Region - step: script: - echo "User name is $Username" - echo "and they are in $Region"

[Branches] > [] > [ブランチでパイプラインを実行] > [カスタム] に移動して、カスタム パイプラインを実行します。

var

オンスケジュール

スケジュールされたパイプラインを使用すると、パイプラインを時間、日、または週単位で実行できます。

  • スケジュールされたパイプラインは、コミットや手動操作でトリガーされるあらゆるビルドに追加して実行できます。

  • bitbucket-pipelines.yml ファイルで定義したすべてのパイプラインにスケジュールを作成できます。

  • カスタム パイプラインを作成した場合、それはスケジュールされたときまたは手動でトリガされたときにのみ実行されます。

セットアップ

パイプラインを作成します。bitbucket-pipelines.yml ファイルでカスタム パイプラインを定義する簡単な例を示します。

例:

1 2 3 4 5 6 pipelines: custom: # defines that this can only be triggered manually or by a schedule staging: # The name that is displayed in the list in the Bitbucket Cloud GUI - step: script: - echo "Scheduled builds in Pipelines are awesome!"

カスタム パイプラインの詳細については、こちらをお読みください。

パイプラインのスケジュールを作成する

  1. Bitbucket のリポジトリに移動します。

  2. [パイプライン] > [スケジュール] (右上) の順に移動して [新規スケジュール] をクリックします。

  3. スケジュールを登録したいブランチパイプラインを選択します。

    • スケジュール実行は、ブランチの HEAD コミットを実行します。

    • パイプラインは、選択したブランチの bitbucket-pipelines.yml の中で定義する必要があります。  

  4. スケジュールを設定します。

    • パイプラインの実行間隔を選択します (時間、日、または週単位)。

    • ご利用のタイムゾーンで時間を選択します。パイプラインは UTC 時刻でスケジュールされます (夏時間の影響は受けません)。

    • スケジュールされたパイプラインは、選択した期間内の任意のタイミングで実行されます。これは、その期間にスケジュールされたパイプラインのトリガーを分散させるためです。

スケジュールの削除

[パイプライン] > [スケジュール] (画面右上の) に移動して、リポジトリのすべてのスケジュールを確認します。

  • スケジュールの右側にあるゴミ箱アイコンを使用してスケジュールを削除します。

  • API を使用して作成されたスケジュールは、Cron 表現 (0 10 15 * * など) で表示されます。

    その他のヘルプ