ドキュメント

デプロイメントイベントとCI設定

GitHub Actions、GitLab CI/CD、または他のCIシステムをリリースのデプロイメント履歴に接続します。

Coroidがリリースのデプロイを認識するのは、あなたのCI/CDがそれを指示した場合のみです。このページでは、パイプラインがデプロイ状況をどのように報告するか、そしてCoroidがそれを開始するか、あるいは自動的に実行されるかを説明します。

Coroid

貴社のCI/CD

環境

  1. 1.開始 指定されたコミットに対して
  2. 2.デプロイ ピン留めされたコミット
  3. 3.レポート 実行中、その後成功または失敗
  4. 4.ヘルス状態を監視 キャニオン・チェックにより確認
デプロイが確定するのはパイプラインから成功報告が届いた後のみです。パイプラインが自動的に開始する場合、ステップ1は省略されます。

以下のすべての設定は、プロジェクト内の各環境ごとに行います。設定 → リリース → デプロイパイプラインそこでレポート用のトークンを作成します。オーナーまたは管理者が一度だけそれを確認できます。その環境のCIパイプライン内でシークレットとして保存してください。Coroidはハッシュ値のみを保持し、トークンを置き換えると古いものは即座に無効になります。このトークンは指定されたプロジェクトおよび環境でのみレポートできます。決して実行しないでください、リポジトリファイルやブラウザリクエスト内に記載しないでください。

GitHubアクションおよびGitLab CI/CD

もしあなたがデプロイ先…リリースページ上のこのボタンを使用するには、次を選択してください。CoroidがGitHubアクションのワークフローを開始しますまたはCoroidがGitLab CI/CDパイプラインを開始しますこれらは環境の「デプロイパイプライン」設定内で行います。正確なデプロイジョブ名、ブランチまたはタグ参照、該当する場合はGitHubワークフローファイル名を入力してください。要求時には、その参照がリリースコミットを指している必要があります。GitHubワークフローは以下を受け取ります。coroid_release_id, coroid_attempt_id, coroid_commit_sha, およびcoroid_environment入力値。GitLabはそれに相当する大文字のCOROID_*変数を受け取ります。これらの値を使ってデプロイを行い、正確なSHAおよび試行回数をレポートします。

環境用のコールバックトークンは、GitHubアクションのシークレットまたはGitLab CI/CDのマスク済み変数に保存してください。デプロイジョブ開始時にrunningイベントを送信し、終了時にsucceeded, failed, またはcancelledイベントを送信します。Coroidは、設定されたパイプラインの成功を認める前に、プロバイダーの実行結果、コミット、指定されたジョブを確認します。ログを確認するには、プロバイダーの実行URLを参照してください。Coroid本番ワークフローには具体的なGitHubアクションの例が含まれています。シークレット名やジョブを自分のリポジトリに合わせて調整してください。

汎用CIコールバック

外部のパイプラインでも、ディスパッチ機能を有効にせずに同じイベントを送信できます。環境限定のビアラートークンで認証してください。エンドポイントはこのバージョン指定形式のJSONを受け付けます:

POST /api/v1/release-deployment-events
Authorization: Bearer <environment-callback-token>
Content-Type: application/json
{
  "schemaVersion": 1,
  "eventId": "ci:run-812:production:succeeded",
  "providerRunId": "run-812",
  "projectId": "<project-uuid>",
  "environmentKey": "production",
  "repository": "owner/repository",
  "commitSha": "0123456789abcdef0123456789abcdef01234567",
  "status": "succeeded",
  "occurredAt": "2026-09-24T12:00:00Z",
  "runUrl": "https://ci.example.com/runs/812"
}

以下を含めてくださいreleaseIdおよびattemptIdCoroidが要求した実行の場合に報告します。failureReason実行失敗の理由を説明できます。queued, running, succeeded, failed, またはcancelledに使用しますstatus実行中は常に一つのproviderRunIdを維持し、各ステータス遷移には一意のeventIdを割り当ててください。同一イベントの再試行時にはIDを維持し、新しいCI実行には新しい実行IDを使用します。イベントのタイムスタンプは最新である必要があります。Coroidは適用前にリポジトリ、環境、コミット、認証範囲、最終ステータスを確認し、矛盾するイベントはレビュー待ちとなります。準備済みのリリースがなくても有効なデプロイが観測可能なリリースを生成でき、これは事前承認済みの候補とは明確に区別されます。

コールバック機能のないパイプラインの場合、オーナーまたは管理者は外部デプロイを記録リリースページで選択します。環境、一致するコミット、時間、理由または証拠URLを指定してください。生成される手動の保証書は、CoroidがCIを実行したりゲートを通過したりしたとは主張せずに結果を記録します。