CI で CLI を使う
このページは任意の CI システムを対象にしています。そのまま使えるワークフローは GitHub Actions から公開する を参照してください。CLI を対話的に使ったことが なければ、CLI をインストールする から始めてください。
1. トークンを渡す
パイプラインはブラウザを開けないため、edge login は使いません。パイプラインに必要な権限だけを持つ パーソナルアクセストークンを作成し、CI のシークレット EDGE_TOKEN として保存します。
EDGE_TOKEN=edge_pat_… # secret: never print it
EDGE_PROFILE=edge.deca-dev.comEDGE_TOKEN が設定されていると、CLI はそれを使い、保存済みのサインインは無視します。EDGE_PROFILE で接続先の環境を明示します。
パイプラインで何ができるかはトークンで決まります。プレビューを公開するなら deployment.read と deployment.write、promote もするなら deployment.promote が必要です。権限スコープ を参照してください。
管理者がマシン認証情報(クライアント ID とシークレット)を発行している場合は、EDGE_TOKEN を設定せずに EDGE_CLIENT_ID と EDGE_CLIENT_SECRET を設定してください。CLI が実行のたびにトークンに交換します。
2. バージョンを固定してインストールする
curl -fsSL https://cli.edge.deca-dev.com/install.sh | EDGE_VERSION=0.1.6 shバージョンを固定すると、新しいリリースでパイプラインの動作が予告なく変わることを防げます。 EDGE_INSTALL_DIR でバイナリの置き場所を選べます。
3. 公開する
edge deploy dist \
--distribution d3f7a1c4-90b2-4e6a-8f15-6c2b7e0a9d38 \
--wait --timeout 10m \
--output json > deployment.json
jq -r .preview_url deployment.json--distributionで公開先を明示します。edge linkで作った.edge/project.jsonをコミットしておく方法でもかまいません。--waitは deployment がreadyかfailedになるまで待つため、ステップの結果が deployment の結果になります。--output jsonは完了した deployment(id、status、preview_urlなど)を JSON で標準出力に書きます。 進捗とエラーは標準エラー出力に出るため、標準出力はそのままパースできます。
ここで公開されるのはプレビューだけです。公開中のサイトは変わりません。 同じジョブで promote するには --promote を加えます。人がプレビューを確認できるよう promote を手動承認の別ステップにしているチームも多く、 その場合は deployment.json の id を使って edge deployments promote ID --wait を実行します。
4. 失敗に対応する
端末がない場合、CLI はプロンプトを表示しません。確認が必要なコマンドは終了コード 2 で失敗し、渡すべき フラグを示します。たとえば edge distributions rm では --confirm-slug acme-marketing です。
メッセージの文字列ではなく、終了コードで分岐してください。
| 終了コード | 意味 | パイプラインでの対応例 |
|---|---|---|
0 | 成功 | 続行 |
3 | トークンがない、期限切れ、取り消し済み、または別の環境のもの | EDGE_TOKEN シークレットを入れ替え、EDGE_PROFILE を確認する |
4 | トークンにスコープが足りない | そのスコープを持つトークンを使う |
6 | 競合または検証エラー | 入力を直す。再試行しても解決しない |
7 | 再試行後もレート制限 | 時間をおいてジョブを再実行する |
8 | deployment が failed で終了 | edge deployments get で deployment のエラーを確認する |
一覧は CLI リファレンス にあります。