ワークフローの停止を Slack チャンネルに通知する

すべての CircleCI config.yml は、最初にバージョンキーを指定します。 このキーは、互換性を損なう変更に関する警告を表示するために使用します。

Slack Orb には、事前にパッケージ化された一連の CircleCI 設定ファイルが含まれており、CI/CD パイプラインにイベントベースの通知を実装するために使用できます。

この Orb をご自身の設定ファイルに追加するには、下記を挿入します。

ジョブは設定の構成要素です。 また、必要に応じてコマンド / スクリプトを実行するステップの集まりです。 ジョブ内のステップは、すべて 1 単位として新しいコンテナまたは仮想マシン内で実行されます。 ジョブに関する詳細は、 ジョブとステップ のページを参照してください。

このガイドでは、プロジェクトのテストおよびデプロイ用のジョブがあることを前提としています。 以下のセクションでは、test と deploy がこれらのジョブになります。

ワークフローは、一連のジョブとその実行順序を定義するためのルールです。 ワークフローを使用すると、設定キーを組み合わせて複雑なジョブオーケストレーションを構成でき、問題の早期解決に役立ちます。 ワークフロー内で、実行したいジョブを定義します。 このワークフローはコミットのたびに実行されます。 詳細は、 ワークフローの設定 を参照して下さい。

ワークフロー、test-hold-deploy が作成されたので、それを使って手動承認を要求する一時停止を間に入れた test ジョブと deploy ジョブの実行をオーケストレーションします。 同時実行、順次実行、および手動承認ワークフローを含むジョブのオーケストレーションの詳細については、 ワークフローを使ったジョブのスケジュール実行 を参照して下さい。

approval ジョブを追加して、手動承認が得られるまでワークフローを一時停止することもできます。 このワークフローは、requires キーを使ってジョブを順次実行するように設定されていることにご注意ください。

Slack Orb には定義済みのジョブ、 on-hold が含まれており、ワークフローが承認を待つために一時停止すると、Slack チャンネルに通知を送信します。 デフォルトの通知テンプレートの詳細については、Orb に関するリンク、 README を参照して下さい。 このジョブを使った様々なオプションの詳細については、 リンク Orb レジストリ を参照して下さい。