特定のコミットまたはプルリクエストのスキップ
設定によっては、リポジトリ内のすべてのコード変更がBitriseビルドをトリガーできます。ただし、必要に応じて特定のコミットやプルリクエストをスキップできます。ここでいうスキップとは、トリガーがそのように設定されていても、コード変更がBitriseでビルドをトリガーしないことを意味します。
ビルドをスキップすると、BitriseはGitプロバイダーにステータスを報告しなくなります。ブランチ保護ルールに必須のステータスチェックが設定されている場合、スキップされたビルドはそのチェックを保留状態のままにし、プルリクエストをマージできなくなります。ドキュメントのみの変更など、ビルドをトリガーすべきでないプルリクエストで必須チェックを通過させるには、ビルドを実行せずに必須チェックを報告するPipelineにルーティングしてください。詳細については、ドキュメントのみのプルリクエストで必須チェックを通過させるをご覧ください。
コミットによるビルドのトリガーを防ぐClick to copy link
特定のコミットがビルドをトリガーしないようにするには、コミットメッセージに[skip ci]または[ci skip]のいずれかを含めます。
This is not important, please [skip ci]
または:
I just changed the README
[ci skip]
複数のコミットをプッシュした場合、skip ciパターンがチェックされるのは最後(先頭)のコミットのメッセージのみで す。
それでもビルドを開始したい場合は、次の2つの方法があります。
- コミットをリベースする(コミットメッセージを変更する)。
- 別のコミットをプッシュする。
Gitでは、空のコミットを作成してプッシュできます。スキップされたビルドを実行したい場合は、対象のブランチでgit commit --allow-empty -m "I decided to run this"を実行し、コミットをプッシュしてください。
プルリクエストによるビルドのトリガーを防ぐClick to copy link
プルリクエストはそれ自体が(仮想的な)コミットとして扱われ、そのコミットメッセージはプルリクエストのタイトルと説明になります。プルリクエストを構成する個々のコミットのコミ ットメッセージではありません。
プルリクエストをスキップするには、プルリクエストのタイトルまたは説明に[skip ci]パターンを含めます。
プルリクエストを構成する個々のコミットのコミットメッセージに[skip ci]パターンを含めても機能しません。適切なトリガーが設定されていれば、プルリクエストはビルドをトリガーします。
プルリクエストをスキップしないことにした場合は、プルリクエストのタイトルまたは説明から[skip ci]パターンを削除するだけで済みます。これにより、最新のコミットで新しいビルドが自動的にトリガーされ、(再度[skip ci]パターンを追加しない限り)以降のプルリクエストのコミットもすべてビルドされます。
ドラフトPRによってトリガーされるStepsのスキップClick to copy link
GitHubのドラフトPR機能を使用すると、Bitriseはビルドの環境変数リストにGITHUB_PR_IS_DRAFTという環境変数を挿入します。この環境変数がビルドの環境変数リストに存在する場合、その値は常にtrueに設定されます。
このGITHUB_PR_IS_DRAFT環境変数は、ビルド内で条件分岐の一部として使用できます。たとえば、ドラフトPRによってトリガーされたビルドで特定のStepsをスキップできます。
workflow1:
steps:
- script:
run_if: '{{enveq "GITHUB_PR_IS_DRAFT" ""}}'
inputs:
- content: |-
#!/usr/bin/env bash
# fail if any commands fails
set -e
# debug log
set -x
この例で は、run_ifという条件は、ビルドがドラフトPRによってトリガーされていない場合にのみStepが実行されることを意味します。
Stepsをスキップするために、Workflow内の各Stepに以下のrun_ifコマンドを挿入することをお勧めします。
GitHubでReady for reviewボタンをクリックすると、ドラフトプルリクエストからのビルドが無効になっている場合に限り、Bitriseで新しいビルドがトリガーされます。
ドラフトプルリクエストがビルドをトリガーするように設定されており、特定のドラフトプルリクエストがすでにビルドをトリガーしている場合、レビュー用に送信しても新しいビルドはトリガーされません。それ以前のビルドにも、ドラフトPR関連の環境変数が含まれます。この場合は、ウェブサイトから手動で新しいビルドを開始するか、新しいコミットでCIをトリガーすることをお勧めします。
Bitrise CIのスキップClick to copy link
マルチベンダーまたはマルチプラットフォームのCIワークフローを管理している場合、複数のシステムでビルドをスキップしたい場合や、Bitriseのみでスキップしたい場合があります。
複数のベンダーでビルドをスキップするには、skip ciまたはci skipキーワードを使用します。
Bitriseのみでビルドをスキップするには、コミットメッセージにskip bitriseまたはbitrise skipキーワードを使用して、Bitriseビルドのトリガーを防ぎます。これらのBitrise固有のスキップキーワードを使用すると、より細かい制御が可能になり、CIパイプラインの他の部分でビルドが意図せずスキップされるのを防げます。
コメントのスキップClick to copy link
PRコメントはビルドをトリガーできますが、これを防ぎたい場合は、ビルドのPRコメントに[skip ci] / [ci skip]または[skip bitrise] /[bitrise skip]を追加することでビルドをスキップできます。
PRに自動でコメントしてビルドを開始するツールを使用している場合は、そのツールがコメントにスキップコマンドを含めるように設定してください。