feat: sub-action delete (#291)

* refactor: output index to deploy folder

* fix: ci deploy

* chore: vscode task watch

* feat: new alias setup

* chore: prettier ordering

* refactor: deploy action

* feat: action delete

* docs: update main readme

* fix: delete action

* docs: delete action description

* feat(delete): batch delection with promise all

* ci(delete): workflow_dispatch

* ci(delete): remove push event

* chore(deps-dev): bump @tsconfig/node20 from 20.1.2 to 20.1.4

* refactor: use alias @/input-keys

* chore(eslint): enable @typescript-eslint/consistent-type-imports

* chore: .env.example cloudflare

* chore(deps-dev): bump eslint-plugin-vitest to 0.4.1

* chore: build output

* refactor(delete): batch-delete file

* test: __fixtures__

* test: api intercept support different method

* test: mock warning for github-actions-core

* feat: batchDelete return object values to output

* feat: delete output deletion to summary

* chore: build

* refactor: delete summary output format

* ci: INPUT_KEY_CLOUDFLARE_ACCOUNT_ID from secret to var

* docs: update delete README

* docs: payload example

* refactor: delete summary use emoji for success

* chore: build

* docs: upgrading

* chore: changeset

Author: andykenward

.changeset/flat-ladybugs-smoke.md

@@ -0,0 +1,6 @@
+---
+"github-actions-cloudflare-pages": major
+---
+- **BREAKING CHANGES:** use the sub-action `unlike-ltd/github-actions-cloudflare-pages/delete` to delete deployments. The main action `unlike-ltd/github-actions-cloudflare-pages` no longer deletes any deployments.
+- **BREAKING CHANGES:** new payload format saved to the GitHub deployments to allow for the sub-action `unlike-ltd/github-actions-cloudflare-pages/delete` to work. To support the older payload the action inputs of `cloudflare-account-id` & `cloudflare_project_name` are required. If an older payload is found and the action inputs are missing, it will silently error and continue; but output in the job summary the deployment.
+

.env.example

@@ -5,3 +5,5 @@ GITHUB_EVENT_NAME=pull_request
 GITHUB_REPOSITORY='unlike-ltd/cloudflare-pages-action'
 GITHUB_EVENT_PATH= file:///workspaces/cloudflare-pages-action/payload-examples/api.github.com/pull_request/opened.payload.json
 GITHUB_GRAPHQL_URL= 'https://api.github.com/graphql'
+CLOUDFLARE_ACCOUNT_ID=
+CLOUDFLARE_API_TOKEN=

.eslintrc.cjs

@@ -46,9 +46,17 @@ const config = {
       rules: {
         '@typescript-eslint/no-var-requires': 'off'
       }
+    },
+    {
+      files: ['__fixtures__/**'],
+      rules: {
+        'unicorn/no-null': 'off',
+        'unicorn/numeric-separators-style': 'off'
+      }
     }
   ],
   rules: {
+    '@typescript-eslint/consistent-type-imports': 'error',
     'unicorn/prefer-top-level-await': 'off',
     'unicorn/prevent-abbreviations': 'off',
     'no-console': 'error'

.github/workflows/deploy-delete.yml

@@ -8,11 +8,6 @@ on:
     branches:
       - main
   workflow_dispatch:
-    inputs:
-      environment:
-        description: 'Environment to run action against'
-        type: environment
-        required: false
 
 concurrency:
   group: deploy-delete-${{ github.head_ref || github.run_id }}
@@ -29,11 +24,7 @@ jobs:
     steps:
       - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 #v4.1.2
       - id: 'cloudflare-pages'
-        uses: ./
+        uses: ./delete
         with:
           cloudflare-api-token: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-          cloudflare-account-id: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-          cloudflare-project-name: ${{ vars.CLOUDFLARE_PROJECT_NAME }}
-          directory: 'example/dist'
           github-token: ${{ secrets.GITHUB_TOKEN }}
-          github-environment: ${{ inputs.environment || 'preview' }}

.github/workflows/deploy.yml

@@ -33,7 +33,7 @@ jobs:
         uses: ./
         with:
           cloudflare-api-token: ${{secrets.CLOUDFLARE_API_TOKEN}}
-          cloudflare-account-id: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          cloudflare-account-id: ${{ vars.CLOUDFLARE_ACCOUNT_ID }}
           cloudflare-project-name: ${{ vars.CLOUDFLARE_PROJECT_NAME }}
           directory: dist
           github-token: ${{ secrets.GITHUB_TOKEN }}

.vscode/tasks.json

@@ -0,0 +1,13 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "typescript",
+      "tsconfig": "tsconfig.json",
+      "option": "watch",
+      "problemMatcher": ["$tsc-watch"],
+      "group": "build",
+      "label": "tsc: watch - tsconfig.json"
+    }
+  ]
+}

README.md

@@ -4,18 +4,15 @@
 
 This action deploys your build output to [Cloudflare Pages] using [Wrangler]. [GitHub Environments] and [GitHub Deployment] are used to keep track of the [Cloudflare Pages] deployments.
 
-When used in context of a [pull request], the action will create a deployment for the pull request and add a comment with the URL of the deployment. On closing the [pull request], all the deployments for that pull request will be deleted from [Cloudflare Pages], GitHub Deployment and the related comment. **The action is only able to delete deployments & comments that it created, as it requires a certain payload in a GitHub deployment.**
+When used in context of a [pull request], the action will create a deployment for the pull request and add a comment with the URL of the deployment.
 
 - Deploy to [Cloudflare Pages].
 - Use [GitHub Environments] & [GitHub Deployment].
 - Comment on pull requests with deployment URL.
-- On pull request close, deletes Cloudflare Pages, GitHub deployments & comments
-- Production branch keeps latest 5 deployments.
+- Delete deployments using [`unlike-ltd/github-actions-cloudflare-pages/delete`](./delete/README.md)
 - Define a `working-directory` input for the `wrangler` cli command to execute from. Useful for monorepos where the `functions` folder may not be in the root directory.
 
-## Usage
-
-### GitHub Environments - **(Required)**
+## GitHub Environments - **(Required)**
 
 > **This GitHub Action doesn't create the required [GitHub Environments], see below for more information.**
 
@@ -27,7 +24,11 @@ For example manually create two GitHub Environments called "production" & "previ
 github-environemnt: ${{ (github.ref == 'refs/heads/main' && 'production') || 'preview' }}
 ```
 
-### Permissions
+## Upgrading
+
+If you have previous deployments using an older version of this GitHub Action please see the [CHANGELOG.md](../CHANGELOG.md) for breaking changes.
+
+## Permissions
 
 The [permissions] required for this GitHub Action when using the created [`GITHUB_TOKEN`] by the workflow for the `github-token` field.
 
@@ -39,85 +40,6 @@ permissions:
   pull-requests: write
 ```
 
-### Examples
-
-See the GitHub Workflow examples below or [deploy.yml](./.github/workflows/deploy.yml) & [deploy-delete.yml](./.github/workflows/deploy-delete.yml)
-
-### `push` & `pull_request`
-
-```yaml
-# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
-name: 'Deployment'
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
-
-jobs:
-  deploy:
-    permissions:
-      actions: read # Only required for private GitHub Repo
-      contents: read
-      deployments: write
-      pull-requests: write
-    runs-on: ubuntu-latest
-    timeout-minutes: 5
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node_version: 20
-      - run: npm ci
-        run: npm run build
-      - name: Deploy to Cloudflare Pages
-        uses: unlike-ltd/github-actions-cloudflare-pages@v1.3.1
-        id: pages
-        with:
-          cloudflare-api-token: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-          cloudflare-account-id: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-          cloudflare-project-name: ${{ vars.CLOUDFLARE_PROJECT_NAME }}
-          directory: dist
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          github-environment: ${{ vars.CLOUDFLARE_PROJECT_NAME }} ${{ (github.ref == 'refs/heads/main' && '(Production)') || '(Preview)' }}
-```
-
-### `pull_request` `closed`
-
-```yaml
-# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
-
-name: 'Deployment Deletion'
-on:
-  pull_request:
-    types:
-      - closed
-    branches:
-      - main
-
-jobs:
-  deploy-delete:
-    permissions:
-      actions: read # Only required for private GitHub Repo
-      contents: read
-      deployments: write
-      pull-requests: write
-    runs-on: ubuntu-latest
-    timeout-minutes: 5
-    steps:
-      - name: Deploy deletion Cloudflare Pages
-        uses: unlike-ltd/github-actions-cloudflare-pages@v1.3.1
-        with:
-          cloudflare-api-token: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-          cloudflare-account-id: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-          cloudflare-project-name: ${{ vars.CLOUDFLARE_PROJECT_NAME }}
-          directory: 'example/dist'
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          github-environment: ${{ vars.CLOUDFLARE_PROJECT_NAME }} ${{ (github.ref == 'refs/heads/main' && '(Production)') || '(Preview)' }}
-```
-
 ## Inputs
 
 ```yaml
@@ -164,6 +86,51 @@ wrangler:
   values: ${{ steps.action.outputs.wrangler }}
 ```
 
+## Examples
+
+See the GitHub Workflow examples below or [deploy.yml](./.github/workflows/deploy.yml)
+
+### `push` & `pull_request`
+
+```yaml
+# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
+name: 'Deployment'
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    permissions:
+      actions: read # Only required for private GitHub Repo
+      contents: read
+      deployments: write
+      pull-requests: write
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node_version: 20
+      - run: npm ci
+        run: npm run build
+      - name: Deploy to Cloudflare Pages
+        uses: unlike-ltd/github-actions-cloudflare-pages@v1.3.1
+        id: pages
+        with:
+          cloudflare-api-token: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          cloudflare-account-id: ${{ vars.CLOUDFLARE_ACCOUNT_ID }}
+          cloudflare-project-name: ${{ vars.CLOUDFLARE_PROJECT_NAME }}
+          directory: dist
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          github-environment: ${{ vars.CLOUDFLARE_PROJECT_NAME }} ${{ (github.ref == 'refs/heads/main' && '(Production)') || '(Preview)' }}
+```
+
 ## Comment Example
 
 ![pull request comment example](./docs/comment.png)
@@ -181,7 +148,11 @@ It will only delete deployments that it created. This is because it requires a c
 ```json
 {
   "payload": {
-    "cloudflareId": "1234",
+    "cloudflare": {
+      "id": "123",
+      "projectName": "cloudflare-pages-project-name",
+      "accountId": "123"
+    },
     "url": "https://example.com",
     "commentId": "1234"
   }

__fixtures__/github-deployment.ts

@@ -0,0 +1,68 @@
+import {
+  MOCK_ACCOUNT_ID,
+  MOCK_DEPLOYMENT_ID,
+  MOCK_PROJECT_NAME
+} from '@/tests/helpers/api.js'
+
+import type {getGitHubDeployments} from '@/common/github/deployment/get.js'
+
+export const DEPLOYMENT: Awaited<
+  ReturnType<typeof getGitHubDeployments>
+>[number] = {
+  url: 'https://api.github.com/repos/unlike-ltd/github-actions-cloudflare-pages/deployments/1423939219',
+  id: 1423939219,
+  node_id: 'DE_kwDOJn0nrM5U35aT',
+  task: 'deploy',
+  original_environment: 'preview',
+  environment: 'preview',
+  description:
+    'Cloudflare Pages Deployment: 4834e1f5-5ed8-417a-9489-13532994a77f',
+  created_at: '2024-04-01T21:03:56Z',
+  updated_at: '2024-04-01T21:03:56Z',
+  statuses_url:
+    'https://api.github.com/repos/unlike-ltd/github-actions-cloudflare-pages/deployments/1423939219/statuses',
+  repository_url:
+    'https://api.github.com/repos/unlike-ltd/github-actions-cloudflare-pages',
+  creator: {
+    login: 'github-actions[bot]',
+    id: 41898282,
+    node_id: 'MDM6Qm90NDE4OTgyODI=',
+    avatar_url: 'https://avatars.githubusercontent.com/in/15368?v=4',
+    gravatar_id: '',
+    url: 'https://api.github.com/users/github-actions%5Bbot%5D',
+    html_url: 'https://github.com/apps/github-actions',
+    followers_url:
+      'https://api.github.com/users/github-actions%5Bbot%5D/followers',
+    following_url:
+      'https://api.github.com/users/github-actions%5Bbot%5D/following{/other_user}',
+    gists_url:
+      'https://api.github.com/users/github-actions%5Bbot%5D/gists{/gist_id}',
+    starred_url:
+      'https://api.github.com/users/github-actions%5Bbot%5D/starred{/owner}{/repo}',
+    subscriptions_url:
+      'https://api.github.com/users/github-actions%5Bbot%5D/subscriptions',
+    organizations_url:
+      'https://api.github.com/users/github-actions%5Bbot%5D/orgs',
+    repos_url: 'https://api.github.com/users/github-actions%5Bbot%5D/repos',
+    events_url:
+      'https://api.github.com/users/github-actions%5Bbot%5D/events{/privacy}',
+    received_events_url:
+      'https://api.github.com/users/github-actions%5Bbot%5D/received_events',
+    type: 'Bot',
+    site_admin: false
+  },
+  sha: '7e7171aff2b6443234556b17c599f5cc27927d17',
+  ref: 'andykenward/issue289',
+  payload: {
+    cloudflare: {
+      id: MOCK_DEPLOYMENT_ID,
+      projectName: MOCK_PROJECT_NAME,
+      accountId: MOCK_ACCOUNT_ID
+    },
+    url: 'https://4834e1f5.cloudflare-pages-action-a5z.pages.dev',
+    commentId: 'IC_kwDOJn0nrM55B77z'
+  },
+  transient_environment: false,
+  production_environment: false,
+  performed_via_github_app: null
+}