ステージオプション

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

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

概要

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

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

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

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

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

ステップを組み合わせて論理的に構造化されたデプロイを形成する。
デプロイのどの部分が失敗したかを簡単に確認する。
完全な再デプロイを実行するのではなく、デプロイの失敗した部分のみを再実行する。

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

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

パイプラインに stage を追加します。
ステージに deployment プロパティを追加します。
ステージに適切な steps を追加します。

例:

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 つのステップで構成されています。

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

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

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

パイプラインアーティファクトがまだ使用可能である必要があります (有効期限が切れていないこと)。
ステージ内のステップを再実行できるのは、同じ環境で新しいデプロイや今後のデプロイがない場合のみです。

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

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

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

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

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

パイプラインアーティファクトがまだ使用可能である必要があります (有効期限が切れていないこと)。
ステージ内のステップを再実行できるのは、同じ環境で新しいデプロイや今後のデプロイがない場合のみです。ステージは最初のステップから再デプロイできます。

制限事項

ステージに含めることができるステップの最大数は次のとおりです。
- Free プランのワークスペースの場合は 10 ステップ
- Standard または Premium プランのワークスペースの場合は 100 ステップ
並行ステージはサポートされていません。
ステージには並行ステップを含めることはできません。
ステージには手動でトリガーされるステップを含めることはできませんが、ステージを手動でトリガーするように設定することは可能です。
ステージには条件付きステップを含めることはできませんが、ステージを条件付きとして設定することは可能です。
ステージ内でのアーティファクトダウンロードの無効化はサポートされていません。
ステップではステージに設定されているプロパティを上書きすることはできません。
部分的に完了したデプロイステージは、それ以降に同じ環境に別の変更がデプロイされた場合は続行できなくなります。

ステージオプション

次のオプションはステージを設定するために使用できます。

段階

段階

ステージを使用すると、共有プロパティを持つパイプラインステップをグループ化できます。たとえば、ステージを使用して、デプロイに必要なステップ (アプリのデプロイやデプロイの成否の確認など) をグループ化できます。

パイプラインステージの作成と使用については、「ステージ」を参照してください。

プロパティ — stage

必須 — いいえ

データタイプ — 改行で区切られたキーと値のペアのブロック (YAML 仕様 - ブロックマッピング)

指定可能な親プロパティ — default、branches、pull-requests、tags、custom

指定可能な子プロパティ — steps (必須)、name、deployment、trigger、condition

例 — stage を使用して、パイプラインステップをグループ化する

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 プロパティには、stage または parallel の step のリストが含まれます。ステップリストには少なくとも 1 つの step が必要です。

プロパティ — steps

必須 — はい

データタイプ — 改行で区切られたキーと値のペアのブロック (YAML 仕様 - ブロックマッピング)

指定可能な親プロパティ — parallel と stage

指定可能な子プロパティ — step (必須)

例 — step プロパティを使用して、並行グループのステップをリストする

pipelines:
  default:
    - step: # sequential step
        name: Build
        script:
          - ./build.sh
    - step: # sequential step
        name: Build
        script:
          - ./build.sh
    - parallel: # these 2 steps will run in parallel
        steps:
          - step:
              name: Integration 1
              script:
                - ./integration-tests.sh --batch 1
          - step:
              name: Integration 2
              script:
                - ./integration-tests.sh --batch 2
    - step:  # non-parallel step
        script:
          - ./deploy.sh

例 — step プロパティを使用して、ステージのステップをリストする

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

条件

condition オプションは、条件またはルールが満たされた場合を除き、step または stage が実行されないようにします。現在、サポートされている条件は changesets のみです。変更したファイルのいずれかが includePaths の表現と一致する場合のみ、changesets を使用して、step または stage を実行できます。includePaths に指定されたファイル一致パターンは、$BITBUCKET_CLONE_DIR ディレクトリに対して相対的です。

考慮される変更内容

pull-requests パイプラインでは、すべてのコミットが考慮され、パターンの includePath リストが提供されている場合は、少なくとも 1 つのコミットの変更が条件のいずれかに一致したときに、step または stage が実行されます。パターンマッチングの形式は、glob パターンに従います。

その他のタイプのパイプラインでは最後のコミットのみが考慮されます。複数のコミットを同時にブランチにプッシュしたり、特定のブランチに複数回プッシュしたりすると、失敗している step または stage は次の実行でスキップされるため、失敗しているパイプラインのみが緑色に変わり、感覚的に不自然な動作が生じることがあります。

プロパティ — condition

必須 — いいえ

データタイプ — 改行で区切られたキーと値のペアのブロック (YAML 仕様 - ブロックマッピング)

指定可能な親プロパティ — step と stage

指定可能な子プロパティ — changesets (必須)

例 — condition オプションを使用して、特定のファイルの変更時のみにステップを実行する

pipelines:
  default:
    - step:
        name: step1
        script:
            - echo "failing paths"
            - exit 1
        condition:
            changesets:
                includePaths:
                  # only xml files directly under path1 directory
                  - "path1/*.xml"
                  # any changes in deeply nested directories under path2
                  - "path2/**"

例 — condition オプションを使用して、特定のファイルの変更時のみにステージを実行する

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

changesets

changesets オプションは、step または stage の condition が特定の 1 つ以上のファイル (includePaths) での変更であることを示すために使用されます。

プロパティ — changesets

必須 — condition オプションを使用する場合は必須です。

データタイプ — 改行で区切られたキーと値のペアのブロック (YAML 仕様 - ブロックマッピング)

指定可能な親プロパティ — condition

指定可能な子プロパティ — includePaths (必須)

例 — condition オプションを使用して、特定のファイルの変更時のみにステップを実行する

pipelines:
  default:
    - step:
        name: step1
        script:
            - echo "failing paths"
            - exit 1
        condition:
            changesets:
                includePaths:
                  # only xml files directly under path1 directory
                  - "path1/*.xml"
                  # any changes in deeply nested directories under path2
                  - "path2/**"

例 — condition オプションを使用して、特定のファイルの変更時のみにステージを実行する

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

includePaths

condition および changesets オプションと一緒に使用すると、includePaths オプションによって、変更を確認するためのファイルまたはディレクトリのリストを提供できます。リスト内のファイルがコミットによって変更されている場合は step または stage が実行され、それ以外の場合はステップがスキップされます。

プロパティ — includePaths

必須 — いいえ

データタイプ — パスのリスト (glob パターンを指定可能) (YAML 仕様 - シーケンス)

指定可能な親プロパティ — changesets

例 — condition オプションを使用して、特定のファイルの変更時のみにステップを実行する

pipelines:
  default:
    - step:
        name: step1
        script:
            - echo "failing paths"
            - exit 1
        condition:
            changesets:
                includePaths:
                  # only xml files directly under path1 directory
                  - "path1/*.xml"
                  # any changes in deeply nested directories under path2
                  - "path2/**"

例 — condition オプションを使用して、特定のファイルの変更時のみにステージを実行する

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 の stage または step の環境を設定し、Deployment ダッシュボードを整理するために使用されます。Deployment ステージに属するすべてのステップが Deployment ステップになります。既定の環境: test、staging、または production。step または stage のデプロイ環境を設定するには、環境名を含めます。

詳細情報

デプロイステージについては「デプロイステージ」をご確認ください。
デプロイ環境の作成と設定については「デプロイのセットアップと監視」をご確認ください。

プロパティ — deployment

必須 — いいえ

データタイプ — 文字列

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

指定可能な親プロパティ — step と stage

例 — deployment を使用して、ステップのデプロイ環境を設定する

pipelines:
  default:
    - step:
        name: Deploy to production
        deployment: production env 1
        script:
          - python deploy.py prod_env_1

例 — deployment を使用して、ステージのデプロイ環境を設定する

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

名前

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

プロパティ — name

必須 — いいえ

データタイプ — 文字列

指定可能な親プロパティ — step、pipe、stage

例 — name を使用して、ステージ、パイプ、および 2 つのステップにラベルを付ける

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
    - step:
        script:
          - pipe: atlassian/slack-notify:latest
            name: Send a message to Slack
            variables:
              WEBHOOK_URL: $SLACK_WEBHOOK
              PRETEXT: 'Hello, Slack!'
              MESSAGE: 'Hello, Slack!!'

トリガー

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

最初の step または stage にはできません。
設定されている順序でのみ実行できます。手動の step または stage はスキップできません。
前の step または stage が正常に完了した場合のみ実行できます。
リポジトリへの書き込みアクセス権限を持つユーザーのみがトリガーできます。
Pipelines の Web インターフェイス経由でトリガーされます。

ビルドが手動ステップとアーティファクトの両方を使用している場合、アーティファクトはそれらのアーティファクトを生成したステップの実行後 14 日間保存されます。この期間が過ぎると、アーティファクトは期限切れとなり、パイプラインでは以降のあらゆる手動ステップと手動ステージを実行できなくなります。

プロパティ — trigger

必須 — いいえ

データタイプ — 文字列

指定可能な値 — automatic と manual

既定値 — automatic

指定可能な親プロパティ — step と stage

例 — trigger を使用して、ステップを手動に設定する

pipelines:
  default:
    - step:
        name: Build
        script:
          - npm run build
        artifacts:
          - dist/**
    - step:
        name: Deploy
        trigger: manual
        script:
          - ./deploy.sh

例 — trigger を使用してステージを手動に設定する

pipelines:
   default:
    - stage:
        name: Linting
        steps:
          - step:
              script:
              - sh ./run-linter.sh
    - 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

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

正確ではなかった

明確ではなかった

関係なかった

Bitbucket サポート

ステージオプション

概要

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

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

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

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

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

制限事項

ステージオプション

段階

例 — stage を使用して、パイプラインステップをグループ化する

手順

例 — step プロパティを使用して、並行グループのステップをリストする

例 — step プロパティを使用して、ステージのステップをリストする

条件

考慮される変更内容

例 — condition オプションを使用して、特定のファイルの変更時のみにステップを実行する

例 — condition オプションを使用して、特定のファイルの変更時のみにステージを実行する

changesets

例 — condition オプションを使用して、特定のファイルの変更時のみにステップを実行する

例 — condition オプションを使用して、特定のファイルの変更時のみにステージを実行する

includePaths

例 — condition オプションを使用して、特定のファイルの変更時のみにステップを実行する

例 — condition オプションを使用して、特定のファイルの変更時のみにステージを実行する

デプロイメント

例 — deployment を使用して、ステップのデプロイ環境を設定する

例 — deployment を使用して、ステージのデプロイ環境を設定する

名前

例 — name を使用して、ステージ、パイプ、および 2 つのステップにラベルを付ける

トリガー

例 — trigger を使用して、ステップを手動に設定する

例 — trigger を使用してステージを手動に設定する

その他のヘルプ

ステージ オプション

概要

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

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

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

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

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

制限事項

ステージ オプション

段階

例 — stage を使用して、パイプライン ステップをグループ化する

手順

例 — step プロパティを使用して、並行グループのステップをリストする

例 — step プロパティを使用して、ステージのステップをリストする

条件

考慮される変更内容

例 — condition オプションを使用して、特定のファイルの変更時のみにステップを実行する

例 — condition オプションを使用して、特定のファイルの変更時のみにステージを実行する

changesets

例 — condition オプションを使用して、特定のファイルの変更時のみにステップを実行する

例 — condition オプションを使用して、特定のファイルの変更時のみにステージを実行する

includePaths

例 — condition オプションを使用して、特定のファイルの変更時のみにステップを実行する

例 — condition オプションを使用して、特定のファイルの変更時のみにステージを実行する

デプロイメント

例 — deployment を使用して、ステップのデプロイ環境を設定する

例 — deployment を使用して、ステージのデプロイ環境を設定する

名前

例 — name を使用して、ステージ、パイプ、および 2 つのステップにラベルを付ける

トリガー

例 — trigger を使用して、ステップを手動に設定する

例 — trigger を使用してステージを手動に設定する

その他のヘルプ

ステージオプション

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

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

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

ステージオプション

例 — stage を使用して、パイプラインステップをグループ化する