ワークフローの仕様

VPC環境で利用できます。

ワークフロー機能で CI/CD自動化とパイプラインの構築が可能です。ワークフローの定義はビジュアルエディタ(Visual Editor)または YAMLを使用して構成でき、SourceCommitリポジトリと連携してワークフローの定義ファイルを管理することで、誰が・いつ・どのようなタスクを行ったか履歴を追跡できます。変更事項に対するレビューやロールバックも簡単に実行できるため、チームメンバー間の協業を円滑にしてビルドとリリースプロセスの信頼性を向上させることができます。

注意

ワークフローの料金は一時的に無料で提供し、有料版の申し込み時に事前に別途お知らせする予定です。

ワークフローの定義ファイル

ワークフローは .yaml フォーマットで定義され、SourceCommitリポジトリの次のパスに位置します。

.sourceband/workflows/*.yaml

ワークフローごとに個別 YAMLファイルで管理され、ファイル名は自由に設定できます。
ワークフローの定義ファイルに関する詳細は、ワークフローフォーマット - YAMLの定義ドキュメントをご参照ください。

ワークフローの構成要素

アクション(Action)

アクションはワークフロー内で実行されるタスク単位です。ワークフローは複数のアクションを含めており、各アクションは順次または並列に構成できます。

詳しいアクション内容は、ワークフローフォーマット-YAMLドキュメントをご参照ください。

アクショングループ(Action Group)

アクショングループは1つ以上のアクションをまとめた単位として、ワークフローをより構造的に構成し管理できるようサポートします。アクショングループ間の依存関係設定も可能であり、特定グループが完了した後に次のグループが実行されるよう調整できます。

詳しいアクショングループ内容は、ワークフローフォーマット-YAMLドキュメントをご参照ください。

トリガー(Triggers)

ワークフロートリガーは特定イベントが発生した際に、ワークフロー実行を自動的に始めるようにします。
トリガーは次のタイプを提供します。

Push: ワークフローの定義ファイルが属するリポジトリの特定ブランチにコードがコミット(push)される時、ワークフローを自動的に実行する条件です。

詳しいトリガー内容は、ワークフローフォーマット-YAMLドキュメントをご参照ください。

ワークフローのステータス

ステータス	説明
Active	ワークフローの定義ファイルが正しく、実行可能なステータスです。トリガーがないか、プッシュトリガーに現在のブランチが含まれています。
Inactive	ワークフローの定義ファイルは正しいですが、実行できないステータスです。プッシュトリガーに現在のブランチが含まれておらず、当該ブランチでは実行できないステータスです。例: ワークフローファイルが mainと developブランチの両方に存在しており、developブランチのみトリガーが設定されている場合の mainブランチのワークフローは Inactiveステータスになります。これにより、同じワークフローの定義が複数のブランチに重複している場合でも、トリガー条件に合致するブランチでのみ実行されるよう保証します。
Invalid	ワークフローの定義にエラーが発生したため、実行できないステータスです。

ワークフローの仕様

リポジトリ連携

ワークフローの定義ファイルは SourceCommitソースリポジトリに保存されます。また、ワークフローを作成するには SourceBandプロジェクトに SourceCommitリポジトリを連携する必要があります。連携方法は、SourceCommitサービス連携をご参照ください。

注意

リポジトリ連携時の注意事項
- リポジトリにワークフローの定義ファイルが既に存在する場合でも、プロジェクトと連携した直後はワークフローが作成されません。
  ワークフローの定義ファイルが含まれたブランチでコミットは発生した場合に作成されます。
リポジトリ連携解除時の注意事項
- リポジトリ連携を解除すると、リポジトリのすべてのワークフローが削除されます。
- ただし、リポジトリ内の YAMLファイルは削除されません。

ワークフロー管理方式

ワークフローはコンソール UIまたは Git CLI方式の中から選択して管理できます:

方式	説明
コンソール UI	コンソールで視覚的にワークフローを作成/変更/削除して管理できます。 Visualエディタと YAMLエディタの両方をサポートします。
Git CLI	Git CLIを利用して `.sourceband/workflows/` フォルダに直接 YAMLファイルを作成/変更/削除して管理できます。