ステージ

現在、この機能はベータ版であり、変更される可能性があります。利用規約については、Atlassian Cloud のサービス利用規約の第 14 条 (評価版、トライアル、ベータ版) を参照してください。

ステージを使用すると、共有プロパティを持つパイプライン ステップを論理的にグループ化できます (デプロイ ステップのグループ化など)。

ステージをセットアップする

パイプラインにステージを追加するには、stage プロパティを追加し、そのステージ内に 1 つ以上のステップをグループ化します。次に例を示します。

1 2 3 4 5 6 7 8 9 10 11 12 13 pipelines: default: - stage: name: Build and test steps: - step: name: Build app script: - sh ./build-app.sh - step: name: Run unit tests script: - sh ./run-tests.sh

ステージのプロパティ

ステージには、必須の steps プロパティに加えて、次のプロパティを設定できます。

必須プロパティ:

オプション プロパティ:

必須プロパティ

手順

steps プロパティでは、ステージ内の step のリストを指定します。ステップ リストには少なくとも 1 つの step が必要です。

プロパティsteps

必須 — はい

タイプブロック シーケンス (リストとも呼ばれる)

指定可能な値step: (詳細については、「step」を参照)

1 2 3 4 5 6 7 8 9 10 11 12 pipelines: default: - stage: steps: - step: name: Build app script: - sh ./build-app.sh - step: name: Run unit tests script: - sh ./run-tests.sh

 

オプション プロパティ

条件

condition プロパティを使用すると、条件またはルールを満たす場合にのみステージを実行できます。ステージ内のすべてのステップに同じ条件が適用されます。

条件の詳細については、ステップ条件を参照してください。

プロパティcondition

必須 — いいえ (オプション プロパティ)

タイプマッピング ノード

指定可能な値changesets: (詳細については、「condition」を参照)

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 pipelines: default: - stage: name: Build and test condition: changesets: includePaths: # only xml files directly under path1 directory - "path1/*.xml" # any changes in deeply nested directories under path2 - "path2/**" steps: - step: name: Build app script: - sh ./build-app.sh - step: name: Run unit tests script: - sh ./run-tests.sh

 

デプロイメント

デプロイ ダッシュボードを整理するために使用されるデプロイ ステージの環境を設定します。デプロイ ステージに属するすべてのステップがデプロイ ステップになります。

デプロイ ステージの詳細については、「デプロイ ステージ」を参照してください。

プロパティdeployment

必須 — いいえ (オプション プロパティ)

タイプ — 文字列

指定可能な値 — 既存のデプロイ環境の名前

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 pipelines: default: - stage: name: Build and test deployment: staging steps: - step: name: Build app script: - sh ./build-app.sh - step: name: Run unit tests script: - sh ./run-tests.sh - stage: name: Deploy to Production deployment: prod trigger: manual steps: - step: name: Build app script: - sh ./build-app.sh - step: name: Run unit tests script: - sh ./run-tests.sh

 

名前

ステージの名前。ステージの名前は、Bitbucket Pipelines のログと Bitbucket UI に表示されます。名前は (パイプライン内で) 一意であり、ステージ内のステップを説明するものでなければなりません。

プロパティname

必須 — いいえ (オプション プロパティ)

タイプ — 文字列

指定可能な値 — 任意の文字列

1 2 3 4 5 6 7 8 9 10 11 12 13 pipelines: default: - stage: name: Build and test steps: - step: name: Build app script: - sh ./build-app.sh - step: name: Run unit tests script: - sh ./run-tests.sh

 

トリガー

ステージを自動的に実行する (既定の動作) か、Bitbucket ユーザー インターフェイスでユーザーが手動でトリガーした場合にのみ実行するように設定します。パイプライン内の最初のステージは手動にはできません。パイプライン全体を手動で実行するように設定するには、カスタム パイプライン トリガーを使用します。

プロパティtrigger

必須 — いいえ (オプション プロパティ)

タイプ — 文字列

既定値automatic

指定可能な値automatic または manual

1 2 3 4 5 6 7 8 9 10 11 12 13 14 pipelines: default: - stage: name: Build and test trigger: manual steps: - step: name: Build app script: - sh ./build-app.sh - step: name: Run unit tests script: - sh ./run-tests.sh

 

デプロイにステージを使用する

デプロイ ステージを使用すると、次のことが可能になります。

  • ステップを組み合わせて論理的に構造化されたデプロイを形成する。

  • デプロイのどの部分が失敗したかを簡単に確認する。

  • 完全な再デプロイを実行するのではなく、デプロイの失敗した部分のみを再実行する。

また、デプロイ ステージは、デプロイ権限同時実行制御による恩恵も受けます。

デプロイ ステージを作成するには、次の手順に従います。

  1. パイプラインに stage を追加します。

  2. ステージに deployment プロパティを追加します。

  3. ステージに適切な steps を追加します。

例:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 pipelines: default: - step: name: Build and test script: - sh ./build-app.sh - stage: name: Deploy to staging deployment: staging steps: - step: name: Deploy script: - sh ./deploy-app.sh - step: name: Run end-to-end tests script: - sh ./run-e2e-tests.sh

このデプロイ ステージは次の 2 つのステップで構成されています。

  1. 最初のステップでは、アプリをステージング環境にデプロイします。

  2. 2 つ目のステップでは、ステージング環境に対してエンドツーエンドのテストを実行し、デプロイによって問題が発生しなかったことを確認します。

未完了のデプロイ ステージを再実行する

デプロイ ステージ内で失敗、一時停止、または停止したステップを再実行することは、ステップを再実行することと似ています。ただし、追加で次のような条件があります。

  • パイプライン アーティファクトがまだ使用可能である必要があります (有効期限が切れていないこと)。

  • ステージ内のステップを再実行できるのは、同じ環境で新しいデプロイや今後のデプロイがない場合のみです。

デプロイ ステージを再デプロイする

以前に成功したデプロイ ステージを再デプロイするには、次の手順に従います。

  • パイプライン アーティファクトがまだ使用可能であること (有効期限が切れていないこと) を確認します。

  • デプロイ ステージ全体を再実行します。

デプロイ ステージの未完了の再デプロイを再実行する

デプロイ ステージ内で失敗または停止したステップを再実行するには、次の手順に従います。

  • パイプライン アーティファクトがまだ使用可能である必要があります (有効期限が切れていないこと)。

  • ステージ内のステップを再実行できるのは、同じ環境で新しいデプロイや今後のデプロイがない場合のみです。ステージは最初のステップから再デプロイできます。

制限事項

  • ステージに含めることができるステップの最大数は次のとおりです。

  • 並行ステージはサポートされていません。

  • ステージには並行ステップを含めることはできません。

  • ステージには手動でトリガーされるステップを含めることはできませんが、ステージを手動でトリガーするように設定することは可能です。

  • ステージには条件付きステップを含めることはできませんが、ステージを条件付きとして設定することは可能です。

  • ステージ内でのアーティファクト ダウンロードの無効化はサポートされていません。

  • ステップではステージに設定されているプロパティを上書きすることはできません。

  • 部分的に完了したデプロイ ステージは、それ以降に同じ環境に別の変更がデプロイされた場合は続行できなくなります。

その他のヘルプ