GitHub Actions から公開する
このページでは、ビルドが静的サイトを dist/ に書き出すリポジトリに、3 つのワークフローを用意します。
| ワークフロー | 実行のきっかけ | 公開中のサイトが変わるか |
|---|---|---|
| プレビュー | すべてのプルリクエスト | いいえ。プレビューを公開して URL をコメントする |
| 本番 | main への push | はい。レビュアーがプレビューを承認したあと |
| 切り戻し | Actions タブのボタン | はい |
例では distribution d3f7a1c4-90b2-4e6a-8f15-6c2b7e0a9d38(acme-marketing、公開 URL は https://acme-marketing.edge.deca-dev.com)に公開します。CLI を使うのが初めてなら、先に CLI をインストールする を読んでください。
1. トークンを 2 つ作成する
distribution があるワークスペースで、Access tokens ページから パーソナルアクセストークン を 2 つ作成します。
| 名前 | 権限 | 使うワークフロー |
|---|---|---|
github-preview | プレビューの公開 | プレビュー |
github-production | 公開と promote | 本番、切り戻し |
トークンを 2 つに分けると、プルリクエストから公開中のサイトを変えることはできなくなります。どちらにも有効期限を付け(90 日がおすすめです)、入れ替える時期を控えておいてください。
2. GitHub に保存する
リポジトリの Settings → Secrets and variables → Actions を開きます。
- Variables タブ:
EDGE_DISTRIBUTION=d3f7a1c4-90b2-4e6a-8f15-6c2b7e0a9d38を追加します。 - Secrets タブ:
github-previewのトークンをEDGE_TOKENとして追加します。
次に Settings → Environments で production という環境を作り、Required reviewers を有効にして、github-production のトークンをその環境に EDGE_TOKEN として追加します。環境のシークレットは同名のリポジトリシークレットより優先され、レビュアーが承認したジョブにだけ渡されます。
3. プルリクエストごとにプレビューを公開する
.github/workflows/edge-preview.yml を作ります。
name: Edge preview
on:
pull_request:
permissions:
contents: read
pull-requests: write # to comment the preview URL
concurrency:
group: edge-preview-${{ github.event.pull_request.number }}
cancel-in-progress: true
env:
EDGE_PROFILE: edge.deca-dev.com
EDGE_VERSION: 0.1.6
jobs:
preview:
# Pull requests from forks do not receive secrets.
if: github.event.pull_request.head.repo.full_name == github.repository
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- uses: actions/checkout@v4
- name: Build
run: npm ci && npm run build
- name: Install edge
run: |
curl -fsSL https://cli.edge.deca-dev.com/install.sh | EDGE_INSTALL_DIR="$HOME/.local/bin" sh
echo "$HOME/.local/bin" >> "$GITHUB_PATH"
- name: Publish preview
id: edge
env:
EDGE_TOKEN: ${{ secrets.EDGE_TOKEN }}
run: |
edge deploy dist --distribution "${{ vars.EDGE_DISTRIBUTION }}" \
--wait --timeout 10m --output json > deployment.json
echo "id=$(jq -r .id deployment.json)" >> "$GITHUB_OUTPUT"
echo "url=$(jq -r .preview_url deployment.json)" >> "$GITHUB_OUTPUT"
- name: Comment the preview URL
env:
GH_TOKEN: ${{ github.token }}
run: |
gh pr comment "${{ github.event.pull_request.number }}" \
--body "Edge preview: ${{ steps.edge.outputs.url }} (deployment \`${{ steps.edge.outputs.id }}\`)"各部分の役割は次のとおりです。
EDGE_PROFILEは CLI の接続先をこの環境の API にします。EDGE_VERSIONはリリースを固定し、新しい CLI で ワークフローの動作が予告なく変わるのを防ぎます。edge deployはdist/をファイルがアーカイブのルートに来る.tar.gzにまとめてアップロードし、commit します。--waitで deployment がreadyになるまで待ちます。deployment が失敗すると、ステップは終了コード8で失敗します。--output jsonは完了した deployment を標準出力に書くため、続く行でjqを使ってidとpreview_urlを読めます。
公開中のサイトは変わりません。 プルリクエストに push するたびに新しいプレビューが公開され、その URL が コメントされます。
4. 承認後に main から promote する
.github/workflows/edge-production.yml を作ります。main のプレビューを公開し、production 環境のレビュアーを待ち、 再ビルドせずに 同じ deployment(レビュアーが開いて確認できたもの)を promote します。
name: Edge production
on:
push:
branches: [main]
permissions:
contents: read
concurrency:
group: edge-production
cancel-in-progress: false
env:
EDGE_PROFILE: edge.deca-dev.com
EDGE_VERSION: 0.1.6
jobs:
preview:
runs-on: ubuntu-latest
timeout-minutes: 20
outputs:
id: ${{ steps.edge.outputs.id }}
url: ${{ steps.edge.outputs.url }}
steps:
- uses: actions/checkout@v4
- name: Build
run: npm ci && npm run build
- name: Install edge
run: |
curl -fsSL https://cli.edge.deca-dev.com/install.sh | EDGE_INSTALL_DIR="$HOME/.local/bin" sh
echo "$HOME/.local/bin" >> "$GITHUB_PATH"
- name: Publish preview
id: edge
env:
EDGE_TOKEN: ${{ secrets.EDGE_TOKEN }}
run: |
edge deploy dist --distribution "${{ vars.EDGE_DISTRIBUTION }}" \
--wait --timeout 10m --output json > deployment.json
echo "id=$(jq -r .id deployment.json)" >> "$GITHUB_OUTPUT"
echo "url=$(jq -r .preview_url deployment.json)" >> "$GITHUB_OUTPUT"
echo "Preview: $(jq -r .preview_url deployment.json)" >> "$GITHUB_STEP_SUMMARY"
promote:
needs: preview
runs-on: ubuntu-latest
timeout-minutes: 15
environment:
name: production
url: https://acme-marketing.edge.deca-dev.com
steps:
- name: Install edge
run: |
curl -fsSL https://cli.edge.deca-dev.com/install.sh | EDGE_INSTALL_DIR="$HOME/.local/bin" sh
echo "$HOME/.local/bin" >> "$GITHUB_PATH"
- name: Promote
env:
EDGE_TOKEN: ${{ secrets.EDGE_TOKEN }}
run: edge deployments promote "${{ needs.preview.outputs.id }}" --wait --timeout 10mmain に push すると、実行は promote で Waiting for review のまま止まります。レビュアーは実行のサマリーから プレビュー URL を開き、Review deployments → Approve をクリックします。そこで初めてジョブに本番用のトークンが 渡され、公開中のサイトが変わります。--wait は https://acme-marketing.edge.deca-dev.com が新しい deployment を配信するまでジョブを待たせます。
concurrency の cancel-in-progress: false は実行を取り消さずに順番待ちにするため、2 つのマージが逆順に promote されることはありません。
5. Actions タブから切り戻す
.github/workflows/edge-rollback.yml を作ります。
name: Edge roll back
on:
workflow_dispatch:
inputs:
to:
description: Deployment to restore (empty = the one before the live deployment)
required: false
permissions:
contents: read
concurrency:
group: edge-production
cancel-in-progress: false
env:
EDGE_PROFILE: edge.deca-dev.com
EDGE_VERSION: 0.1.6
jobs:
rollback:
runs-on: ubuntu-latest
timeout-minutes: 20
environment: production
steps:
- name: Install edge
run: |
curl -fsSL https://cli.edge.deca-dev.com/install.sh | EDGE_INSTALL_DIR="$HOME/.local/bin" sh
echo "$HOME/.local/bin" >> "$GITHUB_PATH"
- name: Roll back
env:
EDGE_TOKEN: ${{ secrets.EDGE_TOKEN }}
TO: ${{ inputs.to }}
run: |
edge deployments rollback --distribution "${{ vars.EDGE_DISTRIBUTION }}" \
${TO:+--to "$TO"} --timeout 15mActions → Edge roll back → Run workflow から実行します。以前の deployment を新しい deployment として復元し、 プレビューを待ってから promote します。公開中のサイトが変わります。 何も削除されません。切り戻す前の deployment は、あとで再び promote できます。edge-production の concurrency グループを共有するため、promote と 競合することはありません。
ステップが失敗したとき
CLI はステップのログで確認できる終了コードで終了します。ワークフローでよく出るものは次のとおりです。
| 終了コード | 原因 | 対処 |
|---|---|---|
3 | トークンが期限切れ、取り消し済み、または別の環境のもの | 新しいトークンを作成し、EDGE_TOKEN シークレットを更新する |
4 | トークンにスコープが足りない。たとえばプレビューのワークフローでの deployment.promote | そのジョブには本番用のトークンを使う |
5 | distribution がトークンのワークスペースにない | EDGE_DISTRIBUTION を確認し、distribution のワークスペースでトークンを作成する |
8 | プレビューの作成中に deployment が失敗した | ビルドが dist/index.html を書き出したかを確認する。edge deployments get ID でエラーを確認できる |
エラーは hint 付きの 1 行の JSON で出力されます。一覧は CLI リファレンス にあります。
次に読む
- CI で CLI を使う: ほかの CI システムでの同じ流れ
- パッチ、公開、切り戻し
- CLI リファレンス