PRが閉じられたら自動的にNetlifyのDeployを削除する

2025-01-11

Tech

Netlify

/

GitHub Actions

Deploy に紐づけられているブランチ名を確認する#

デプロイ手法（公式の GitHub 連携機能を利用するか、Netlify CLI や Netlify API を利用するかなど）によって、Deploy に紐づけられるブランチ名の形式が異なるため、まずはその確認を行う。

次のコマンドを実行すると、サイトに紐づけられた最新の Deploy 最大 100 件を取得できる。

1
curl -s -X GET \
2
    -H "Authorization: Bearer $NETLIFY_TOKEN" \
3
    "https://api.netlify.com/api/v1/sites/$SITE_ID/deploys"

$NETLIFY_TOKENには、Netlify の Personal Access Token を指定する。

$SITE_IDには、Netlify のサイト ID を指定する。Netlify で対応したいサイトの「Site configuration」を開き、Site information の中にある「Site ID」がそれに該当する。自身が定義したサイト名ではないので注意。

コマンドを実行すると、次のようなレスポンスが得られる。ここにあるbranchフィールドが、ブランチ名に相当するので形式を覚えておく。

1
[
2
  {
3
    "id": "6780b5257d6fc6786f803ba8",
4
    "site_id": "d098883f-e010-44ac-a441-00b7fc5b6bda",
5
    "build_id": null,
6
    "state": "ready",
7
    "name": "my-site",
8
    "url": "http://my-site.netlify.app",
9
    "ssl_url": "https://my-site.netlify.app",
10
    "admin_url": "https://app.netlify.com/sites/my-site",
11
    "deploy_url": "http://deploy-preview-1189--my-site.netlify.app",
12
    "deploy_ssl_url": "https://deploy-preview-1189--my-site.netlify.app",
13
    // ...
14
    "branch": "deploy-preview-1189",
15
    "links": {
16
      "permalink": "https://6780b5257d6fc6786f803ba8--my-site.netlify.app",
17
      "alias": "https://deploy-preview-1189--my-site.netlify.app",
18
      "branch": null
19
    }
20
    // ...
21
  }
22
  // ...
23
]

次のように branch クエリパラメータに、取得したブランチ名を指定すると、そのブランチに紐づけられた Deploy のみを取得できる。

1
curl -s -X GET \
2
    -H "Authorization: Bearer $NETLIFY_TOKEN" \
3
    -d branch=$BRANCH_NAME \
4
    "https://api.netlify.com/api/v1/sites/$SITE_ID/deploys" |

Preview deploy と Alias deploy#

Pull Request に紐づいた Deploy には、少なくとも次の 2 種類がある。この分類は公式のドキュメントによるものではなく、Netlify Support Forums の記述を元にしているため正確でない可能性がある。

Preview deploy
Alias deploy

それぞれ次のような形式になっている。Alias deploy の形式は、Deploy 手法によるが、特殊なことをしていなければ PR 毎に一意な URL が生成される。

Preview deploy：hash値--site-name.netlify.app
Alias deploy：deploy-preview-PR番号--site-name.netlify.app

Preview deploy は、Pull Request で push などで Deploy が要求される度に新しい Deploy が作成され、異なる URL が生成される。

Preview deploy が行われる度に、Alias deploy へのエイリアスが貼られる。

Alias deploy を削除する#

Netlify API や Netlify CLI を見ても、Alias deploy を削除するためのエンドポイントやコマンドは見当たらない。

Alias deploy には、Pull Request の全ての Preview deploy がエイリアスとして紐づいているため、最新の Preview deploy を削除しても、Alias deploy は 1 つ前の Preview deploy にフォールバックし存続する。

Alias deploy を無効化するには、Pull Request に紐づいた全ての Preview deploy を削除する必要がある。

次のように、ブランチに紐づけられた全ての Deploy を取得した後に、それぞれを削除することで Alias deploy を無効化できる。

1
curl -s -X GET \
2
    -H "Authorization: Bearer $NETLIFY_TOKEN" \
3
    -d branch=$BRANCH_NAME \
4
    "https://api.netlify.com/api/v1/sites/$SITE_ID/deploys" | \
5
jq -r '.[].id' | \
6
while read -r deploy_id; do
7
    echo "Deleting deploy ID: $deploy_id"
8
    curl -s -X DELETE \
9
        -H "Authorization: Bearer $NETLIFY_TOKEN" \
10
        "https://api.netlify.com/api/v1/sites/$SITE_ID/deploys/$deploy_id"
11
done

これはブランチに紐づいた Deploy が 100 件を超えることはないという前提で書いている。超えるケースを考慮するのであれば、ページネーションを考慮する必要がある。

ref: https://open-api.netlify.com/#tag/deploy/operation/listSiteDeploys

Pull Request に紐づけられた Netlify Deploy を削除する GitHub Actions#

ここまでの内容を GitHub Actions に組み込んで、Pull Request が閉じられた際に自動的に Netlify Deploy を削除するワークフローを次のように作成できる。

1
name: Delete Netlify Deploy Preview
2

3
on:
4
  pull_request:
5
    types:
6
      - closed
7

8
env:
9
  NETLIFY_TOKEN: ${{ secrets.NETLIFY_TOKEN }}
10
  # Netlify上のSite IDを記載する
11
  SITE_ID: ""
12

13
jobs:
14
  delete_netlify_deploy:
15
    runs-on: ubuntu-latest
16

17
    steps:
18
      - name: Get branch name
19
        id: branch
20
        # ここのnameの形式は、NetlifyへのDeploy手法によって異なる可能性があるため、適宜変更する
21
        run: |
22
          echo "name=deploy-preview-${{ github.event.pull_request.number }}" >> $GITHUB_OUTPUT
23
      - name: Fetch and delete deploys from Netlify
24
        shell: bash
25
        env:
26
          BRANCH_NAME: ${{ steps.branch.outputs.name }}
27
        run: |
28
          curl -s -X GET \
29
              -H "Authorization: Bearer $NETLIFY_TOKEN" \
30
              -d branch=$BRANCH_NAME \
31
              "https://api.netlify.com/api/v1/sites/$SITE_ID/deploys" | \
32
          jq -r '.[].id' | \
33
          while read -r deploy_id; do
34
              echo "Deleting deploy ID: $deploy_id"
35
              curl -s -X DELETE \
36
                  -H "Authorization: Bearer $NETLIFY_TOKEN" \
37
                  "https://api.netlify.com/api/v1/sites/$SITE_ID/deploys/$deploy_id"
38
          done