グローバル オプション

bitbucket-pipelines.ymloptions セクションでは、ステップの最大実行時間や Pipelines Docker コンテナーに割り当てられるリソースなど、リポジトリのすべてのパイプラインに対して、いくつかのグローバル オプションを設定できます。その他のオプションはグローバルに設定できますが、Git クローン オプション、Docker イメージ オプション、キャッシュとサービスのコンテナー オプションなど、bitbucket-pipelines.yml に専用のセクションを保持します。

パイプラインのグローバル オプション

以下のグローバル オプションは、options プロパティで設定されています。

オプション

すべてのパイプラインに適用するグローバル設定を含みます。

プロパティoptions

必須 — いいえ

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

指定可能な親プロパティ — YAML ルート (options は必ず最上位のプロパティとなります)

指定可能な子プロパティmax-timedockersize、および runtime プロパティが 1 つ以上必要です。

例 — options オプションを使用して、パイプラインのグローバル オプションを設定する

1 2 3 4 5 6 7 8 9 10 11 options: max-time: 30 docker: true size: 2x pipelines: default: - step: name: Hello world example script: - echo "Hello, World!"

Docker

グローバル docker オプションは、パイプラインのすべてのステップに Docker サービスを追加します。この Docker サービスは、Docker コマンドを実行するためにいずれのパイプライン ステップでも使用できます。Bitbucket Pipeline での Docker の使用に関する情報は、「Bitbucket Pipelines で Docker コマンドを実行する」をご参照ください。

プロパティdocker

必須 — いいえ

データ タイプ — ブール値

指定可能な値true または false

既定値false

指定可能な親プロパティoptions

例 — docker を使用して、Docker コマンドをすべてのパイプライン ステップで有効にする

1 2 3 4 5 6 7 8 9 10 options: docker: true pipelines: default: - step: name: Hello world example script: - docker version - docker run hello-world

例 — services を使用して、単一ステップで Docker コマンドを有効にする

1 2 3 4 5 6 7 8 pipelines: default: - step: script: - docker version - docker run hello-world services: - docker

最長時間

max-time オプションは、タイムアウトする前にステップを実行できる最大時間 (分単位) を設定します。max-time オプションは、グローバル options プロパティと個々のパイプライン ステップの両方で設定できます。パイプライン ステップの既定の最大時間は 120 分です。

プロパティmax-time

必須 — いいえ

データ タイプ — 整数

指定可能な値1120 の間の正の整数

既定値120

指定可能な親プロパティoptionsstep

例 — max-time オプションを使用して、パイプラインの各ステップに指定可能な最大時間を設定する

1 2 3 4 5 6 7 8 9 options: max-time: 30 pipelines: default: - step: name: Sleeping step script: - sleep 120m # This step will timeout after 30 minutes

例 — max-time オプションを使用して、パイプラインの個別のステップに指定可能な最大時間を設定する

1 2 3 4 5 6 7 8 9 10 11 12 13 options: max-time: 60 pipelines: default: - step: name: Sleeping step script: - sleep 120m # This step will timeout after 60 minutes - step: name: quick step max-time: 5 script: - sleep 120m # This step will timeout after 5 minutes

サイズ

size オプションは、ステップまたはパイプライン全体に追加のメモリを割り当てます。2x のサイズを指定すると、利用可能なメモリが 2 倍になります。1x (初期設定) ステップには 4 GB のメモリが割り当てられ、2x ステップには 8 GB のメモリが割り当てられます。割り当てられたメモリは、stepscript と、step のすべての services の両方で共有されます。

このオプションは、Bitbucket Cloud インフラストラクチャと Linux Docker 自社ホスト ランナーで実行されるステップで利用できます。Windows PowerShell、macOS シェル、Linux シェル ランナーなどのシェルベースのランナーは、ホストマシンで利用可能なすべてのメモリを使用します。

4x ステップでは 1x ステップのビルド分数の 4 倍、2x ステップは 1x ステップのビルド分数の 2 倍を要します。

サイズに基づくリソース割り当て

サイズ

CPU

メモリ

1x

4

4

2x

4

8

4x

8

16

8x

16

32

プロパティsize

必須 — いいえ

データ タイプ — 文字列

指定可能な値 — 次のいずれか:

4x and 8x pipelines size options are only available for builds running under a paid Bitbucket Cloud plan (Standard or Premium).

既定値1x

指定可能な親プロパティoptionsstep

例 — size オプションを使用して、すべてのパイプライン ステップで利用可能なメモリを増やす

1 2 3 4 5 6 7 8 options: size: 2x pipelines: default: - step: script: - echo "2x memory is probably not needed for an echo command"

例 — size オプションを使用して、パイプライン ステップで利用可能なメモリを増やす

1 2 3 4 5 6 pipelines: default: - step: size: 2x script: - echo "This step gets double the memory!"

ランタイム

ステップに適用されるランタイム設定です。

プロパティruntime

必須 — いいえ

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

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

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

例 - ランタイムを使用して、4x、8x のすべてのステップで atlassian-ip-ranges を有効にする

1 2 3 4 5 6 7 8 9 10 options: runtime: cloud: atlassian-ip-ranges: true pipelines: default: - step: size: 4x script: - echo "I use atlassian-ip-ranges"

例 - ランタイムを使用して、特定のステップで atlassian-ip-ranges を有効にする

1 2 3 4 5 6 7 8 9 pipelines: default: - step: size: 4x runtime: cloud: atlassian-ip-ranges: true script: - echo "I use atlassian-ip-ranges"

 

クラウド ランタイム設定

クラウド ステップに適用されるランタイム設定です。

プロパティcloud

必須 — いいえ

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

指定可能な親プロパティruntime

指定可能な子プロパティatlassian-ip-ranges (必須)

クラウド ランタイム設定用のアトラシアン IP 範囲

このオプションでは、入出力トラフィックのステップを実行するときに、既定の aws-ip-ranges と atlassian-ip-ranges のどちらを使用するかを指定します。

プロパティatlassian-ip-ranges

必須 — はい

データ タイプ — ブール値

指定可能な値true または false

既定値false

指定可能な親プロパティcloud

エクスポート - Bitbucket Premium のみ

パイプライン定義を同じワークスペース内の他のリポジトリと共有するかどうかを指定します。

プロパティexport

必須 — いいえ

データ タイプ — ブール値

指定可能な値true または false

既定値false

指定可能な親プロパティ — YAML ルート (export は必ず最上位のプロパティとなります)

例 — エクスポート オプションで definitions セクションの pipelines をエクスポートする

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 export: true definitions: caches: services: pipelines: export-pipeline: - step: script: - echo hello pipelines default: - step: script: - echo hello

 

 

さらにヘルプが必要ですか?

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