Whole bunch of general improvements

README.md

@@ -31,6 +31,7 @@ GitHub Action for creating Cloudflare Pages deployments, using the new [Direct U
              accountId: YOUR_ACCOUNT_ID
              projectName: YOUR_PROJECT_NAME
              directory: YOUR_ASSET_DIRECTORY
+             # Optional: Enable this if you want to have GitHub Deployments triggered
              gitHubToken: ${{ secrets.GITHUB_TOKEN }}
    ```
 

action.yml

@@ -18,7 +18,7 @@ inputs:
     required: true
   gitHubToken:
     description: "GitHub Token"
-    required: true
+    required: false
   branch:
     description: "The name of the branch you want to deploy to"
     required: false

package.json

@@ -21,13 +21,14 @@
   },
   "homepage": "https://github.com/cloudflare/pages-action#readme",
   "dependencies": {
-    "@actions/core": "^1.8.0",
-    "@actions/github": "^5.0.1",
-    "shellac": "^0.7.0",
-    "undici": "^5.1.1"
+    "@actions/core": "^1.10.0",
+    "@actions/github": "^5.1.1",
+    "@cloudflare/types": "^6.16.10",
+    "shellac": "^0.7.2",
+    "undici": "^5.11.0"
   },
   "devDependencies": {
-    "esbuild": "^0.14.38",
+    "esbuild": "^0.15.12",
     "husky": "^8.0.1",
     "prettier": "^2.6.2",
     "typescript": "^4.6.4"

src/index.ts

@@ -2,57 +2,14 @@ import { getInput, setOutput, setFailed } from "@actions/core";
 import { context, getOctokit } from "@actions/github";
 import shellac from "shellac";
 import { fetch } from "undici";
-
-// TODO: Confirm types
-
-interface Stage {
-  name: string;
-  started_on: null | string;
-  ended_on: null | string;
-  status: string;
-}
-
-interface Deployment {
-  id: string;
-  short_id: string;
-  project_id: string;
-  project_name: string;
-  environment: string;
-  url: string;
-  created_on: string;
-  modified_on: string;
-  latest_stage: Stage;
-  deployment_trigger: {
-    type: string;
-    metadata: {
-      branch: string;
-      commit_hash: string;
-      commit_message: string;
-      commit_dirty: boolean;
-    };
-  };
-  stages: Stage[];
-  build_config: {
-    build_command: null | string;
-    destination_dir: null | string;
-    root_dir: null | string;
-    web_analytics_tag: null | string;
-    web_analytics_token: null | string;
-    fast_builds: boolean;
-  };
-  env_vars: unknown;
-  kv_namespaces: Record<string, { namespace_id: string }>;
-  aliases: null | string[];
-  is_skipped: boolean;
-  production_branch: string;
-}
+import { Deployment } from '@cloudflare/types';
 
 try {
   const apiToken = getInput("apiToken", { required: true });
   const accountId = getInput("accountId", { required: true });
   const projectName = getInput("projectName", { required: true });
   const directory = getInput("directory", { required: true });
-  const gitHubToken = getInput("gitHubToken", { required: true });
+  const gitHubToken = getInput("gitHubToken", { required: false });
   const branch = getInput("branch", { required: false });
 
   const octokit = getOctokit(gitHubToken);
@@ -97,11 +54,13 @@ try {
   const createGitHubDeploymentStatus = async ({
     id,
     url,
+    deploymentId,
     environmentName,
     productionEnvironment,
   }: {
     id: number;
     url: string;
+    deploymentId: string;
     environmentName: string;
     productionEnvironment: boolean;
   }) => {
@@ -113,13 +72,17 @@ try {
       environment: environmentName,
       environment_url: url,
       production_environment: productionEnvironment,
-      log_url: `https://dash.cloudflare.com/${accountId}/pages/view/${projectName}/${id}`,
+      log_url: `https://dash.cloudflare.com/${accountId}/pages/view/${projectName}/${deploymentId}`,
       description: "Cloudflare Pages",
       state: "success",
     });
   };
 
   (async () => {
+    if (gitHubToken === "") {
+      return;
+    }
+
     const gitHubDeployment = await createGitHubDeployment();
 
     const pagesDeployment = await createPagesDeployment();
@@ -127,17 +90,19 @@ try {
     setOutput("id", pagesDeployment.id);
     setOutput("url", pagesDeployment.url);
     setOutput("environment", pagesDeployment.environment);
+    setOutput("alias", pagesDeployment.environment === "production" ? pagesDeployment.url : pagesDeployment.aliases[0]);
 
-    const url = new URL(pagesDeployment.url);
     const productionEnvironment = pagesDeployment.environment === "production";
     const environmentName = productionEnvironment
       ? "Production"
-      : `Preview (${url.host.split(".")[0]})`;
+      // Use the branch alias (staging/walshy-fix-bug)
+      : `Preview (${pagesDeployment.aliases[0]})`;
 
     if (gitHubDeployment) {
       await createGitHubDeploymentStatus({
         id: gitHubDeployment.id,
         url: pagesDeployment.url,
+        deploymentId: pagesDeployment.id,
         environmentName,
         productionEnvironment,
       });