Skip to content

CI で CLI を使う ​

このページは任意の CI システムを対象にしています。そのまま使えるワークフローは GitHub Actions から公開する を参照してください。CLI を対話的に使ったことが なければ、CLI をインストールする から始めてください。

1. トークンを渡す ​

パイプラインはブラウザを開けないため、edge login は使いません。パイプラインに必要な権限だけを持つ パーソナルアクセストークンを作成し、CI のシークレット EDGE_TOKEN として保存します。

bash
EDGE_TOKEN=edge_pat_…   # secret: never print it
EDGE_PROFILE=edge.deca-dev.com

EDGE_TOKEN が設定されていると、CLI はそれを使い、保存済みのサインインは無視します。EDGE_PROFILE で接続先の環境を明示します。

パイプラインで何ができるかはトークンで決まります。プレビューを公開するなら deployment.read と deployment.write、promote もするなら deployment.promote が必要です。権限スコープ を参照してください。

管理者がマシン認証情報(クライアント ID とシークレット)を発行している場合は、EDGE_TOKEN を設定せずに EDGE_CLIENT_ID と EDGE_CLIENT_SECRET を設定してください。CLI が実行のたびにトークンに交換します。

2. バージョンを固定してインストールする ​

bash
curl -fsSL https://cli.edge.deca-dev.com/install.sh | EDGE_VERSION=0.1.6 sh

バージョンを固定すると、新しいリリースでパイプラインの動作が予告なく変わることを防げます。 EDGE_INSTALL_DIR でバイナリの置き場所を選べます。

3. 公開する ​

bash
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再試行後もレート制限時間をおいてジョブを再実行する
8deployment が failed で終了edge deployments get で deployment のエラーを確認する

一覧は CLI リファレンス にあります。

次に読む ​