test branch

.changeset/eighty-sloths-wave.md

@@ -1,5 +0,0 @@
----
-"wrangler-action": patch
----
-
-Use `secret bulk` instead of deprecated `secret:bulk` command

.changeset/lemon-bags-happen.md

@@ -0,0 +1,5 @@
+---
+"wrangler-action": patch
+---
+
+Handle failures in createGitHubDeployment and createGitHubJobSummary

.changeset/real-bananas-poke.md

@@ -0,0 +1,5 @@
+---
+"wrangler-action": minor
+---
+
+Use wrangler outputs for version upload and wrangler deploy

.gitignore

@@ -1,4 +1,3 @@
-dist
 .idea
 .vscode
 

CHANGELOG.md

@@ -1,15 +1,5 @@
 # Changelog
 
-## 3.14.0
-
-### Minor Changes
-
-- [#351](https://github.com/cloudflare/wrangler-action/pull/351) [`4ff07f4`](https://github.com/cloudflare/wrangler-action/commit/4ff07f4310dc5067d84a254cd9af3d2e91df119e) Thanks [@Maximo-Guk](https://github.com/Maximo-Guk)! - Use wrangler outputs for version upload and wrangler deploy
-
-### Patch Changes
-
-- [#350](https://github.com/cloudflare/wrangler-action/pull/350) [`e209094`](https://github.com/cloudflare/wrangler-action/commit/e209094e624c6f6b418141b7e9d0ab7838d794a3) Thanks [@Maximo-Guk](https://github.com/Maximo-Guk)! - Handle failures in createGitHubDeployment and createGitHubJobSummary
-
 ## 3.13.1
 
 ### Patch Changes

dist/commandOutputParsing.d.ts

@@ -0,0 +1,2 @@
+import { WranglerActionConfig } from "./wranglerAction";
+export declare function handleCommandOutputParsing(config: WranglerActionConfig, command: string, stdOut: string): Promise<void>;

dist/exec.d.ts

@@ -0,0 +1,6 @@
+import { exec as _childProcessExec } from "node:child_process";
+export { exec } from "@actions/exec";
+declare const childProcessExec: typeof _childProcessExec.__promisify__;
+export declare function execShell(command: string, { silent, ...options }?: Parameters<typeof childProcessExec>[1] & {
+    silent?: boolean;
+}): Promise<number | null>;

dist/index.d.ts

@@ -0,0 +1 @@
+export {};

dist/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

dist/packageManagers.d.ts

@@ -0,0 +1,24 @@
+export interface PackageManager {
+    install: string;
+    exec: string;
+    execNoInstall: string;
+}
+export declare function getPackageManager(name: string, { workingDirectory }?: {
+    workingDirectory?: string;
+}): {
+    readonly install: "npm i";
+    readonly exec: "npx";
+    readonly execNoInstall: "npx --no-install";
+} | {
+    readonly install: "yarn add";
+    readonly exec: "yarn";
+    readonly execNoInstall: "yarn";
+} | {
+    readonly install: "pnpm add";
+    readonly exec: "pnpm exec";
+    readonly execNoInstall: "pnpm exec";
+} | {
+    readonly install: "bun i";
+    readonly exec: "bunx";
+    readonly execNoInstall: "bun run";
+};

dist/packageManagers.test.d.ts

@@ -0,0 +1 @@
+export {};

dist/service/github.d.ts

@@ -0,0 +1,23 @@
+import { getOctokit } from "@actions/github";
+import { OutputEntryPagesDeployment } from "../wranglerArtifactManager";
+import { WranglerActionConfig } from "../wranglerAction";
+type Octokit = ReturnType<typeof getOctokit>;
+export declare function createGitHubDeployment({ config, octokit, productionBranch, environment, deploymentId, projectName, deploymentUrl, }: {
+    config: WranglerActionConfig;
+    octokit: Octokit;
+    productionBranch: string;
+    environment: string;
+    deploymentId: string | null;
+    projectName: string;
+    deploymentUrl?: string;
+}): Promise<void>;
+export declare function createJobSummary({ commitHash, deploymentUrl, aliasUrl, }: {
+    commitHash: string;
+    deploymentUrl?: string;
+    aliasUrl?: string;
+}): Promise<void>;
+/**
+ * Create github deployment, if GITHUB_TOKEN is present in config
+ */
+export declare function createGitHubDeploymentAndJobSummary(config: WranglerActionConfig, pagesArtifactFields: OutputEntryPagesDeployment): Promise<void>;
+export {};

dist/service/github.spec.d.ts

@@ -0,0 +1 @@
+export {};

dist/test/fixtures/build-quiet/index.d.ts

@@ -0,0 +1,8 @@
+type Env = {
+    SECRET1?: string;
+    SECRET2?: string;
+};
+declare const _default: {
+    fetch(request: Request, env: Env): Response;
+};
+export default _default;

dist/test/fixtures/bun/index.d.ts

@@ -0,0 +1,8 @@
+type Env = {
+    SECRET1?: string;
+    SECRET2?: string;
+};
+declare const _default: {
+    fetch(request: Request, env: Env): Response;
+};
+export default _default;

dist/test/fixtures/environment/index.d.ts

@@ -0,0 +1,8 @@
+type Env = {
+    SECRET1?: string;
+    SECRET2?: string;
+};
+declare const _default: {
+    fetch(request: Request, env: Env): Response;
+};
+export default _default;

dist/test/fixtures/npm/index.d.ts

@@ -0,0 +1,8 @@
+type Env = {
+    SECRET1?: string;
+    SECRET2?: string;
+};
+declare const _default: {
+    fetch(request: Request, env: Env): Response;
+};
+export default _default;

dist/test/fixtures/only-build/index.d.ts

@@ -0,0 +1,8 @@
+type Env = {
+    SECRET1?: string;
+    SECRET2?: string;
+};
+declare const _default: {
+    fetch(request: Request, env: Env): Response;
+};
+export default _default;

dist/test/fixtures/pnpm/index.d.ts

@@ -0,0 +1,8 @@
+type Env = {
+    SECRET1?: string;
+    SECRET2?: string;
+};
+declare const _default: {
+    fetch(request: Request, env: Env): Response;
+};
+export default _default;

dist/test/fixtures/pre-installed-wrangler/index.d.ts

@@ -0,0 +1,8 @@
+type Env = {
+    SECRET1?: string;
+    SECRET2?: string;
+};
+declare const _default: {
+    fetch(request: Request, env: Env): Response;
+};
+export default _default;

dist/test/fixtures/secrets-default/index.d.ts

@@ -0,0 +1,8 @@
+type Env = {
+    SECRET1?: string;
+    SECRET2?: string;
+};
+declare const _default: {
+    fetch(request: Request, env: Env): Response;
+};
+export default _default;

dist/test/fixtures/secrets-v2/index.d.ts

@@ -0,0 +1,8 @@
+type Env = {
+    SECRET1?: string;
+    SECRET2?: string;
+};
+declare const _default: {
+    fetch(request: Request, env: Env): Response;
+};
+export default _default;

dist/test/fixtures/specify-package-manager/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

dist/test/fixtures/unspecified-package-manager/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

dist/test/fixtures/yarn/index.d.ts

@@ -0,0 +1,8 @@
+type Env = {
+    SECRET1?: string;
+    SECRET2?: string;
+};
+declare const _default: {
+    fetch(request: Request, env: Env): Response;
+};
+export default _default;

dist/test/mocks.d.ts

@@ -0,0 +1,6 @@
+export declare function mockGithubDeployments({ githubUser, githubRepoName, }: {
+    githubUser: string;
+    githubRepoName: string;
+}): {
+    handlers: import("msw").HttpHandler[];
+};

dist/test/test-utils.d.ts

@@ -0,0 +1,4 @@
+import { WranglerActionConfig } from "../wranglerAction";
+export declare function getTestConfig({ config, }?: {
+    config?: Partial<WranglerActionConfig>;
+}): WranglerActionConfig;

dist/utils.d.ts

@@ -0,0 +1,9 @@
+import { WranglerActionConfig } from "./wranglerAction";
+/**
+ * A helper function to compare two semver versions. If the second arg is greater than the first arg, it returns true.
+ */
+export declare function semverCompare(version1: string, version2: string): boolean;
+export declare function checkWorkingDirectory(workingDirectory?: string): string;
+export declare function info(config: WranglerActionConfig, message: string, bypass?: boolean): void;
+export declare function warn(config: WranglerActionConfig, message: string, bypass?: boolean): void;
+export declare function error(config: WranglerActionConfig, message: string, bypass?: boolean): void;

dist/utils.test.d.ts

@@ -0,0 +1 @@
+export {};

dist/wranglerAction.d.ts

@@ -0,0 +1,54 @@
+import { z } from "zod";
+import { PackageManager } from "./packageManagers";
+import { info } from "./utils";
+export type WranglerActionConfig = z.infer<typeof wranglerActionConfig>;
+export declare const wranglerActionConfig: z.ZodObject<{
+    WRANGLER_VERSION: z.ZodString;
+    didUserProvideWranglerVersion: z.ZodBoolean;
+    secrets: z.ZodArray<z.ZodString, "many">;
+    workingDirectory: z.ZodString;
+    CLOUDFLARE_API_TOKEN: z.ZodString;
+    CLOUDFLARE_ACCOUNT_ID: z.ZodString;
+    ENVIRONMENT: z.ZodString;
+    VARS: z.ZodArray<z.ZodString, "many">;
+    COMMANDS: z.ZodArray<z.ZodString, "many">;
+    QUIET_MODE: z.ZodBoolean;
+    PACKAGE_MANAGER: z.ZodString;
+    WRANGLER_OUTPUT_DIR: z.ZodString;
+    GITHUB_TOKEN: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    WRANGLER_VERSION: string;
+    didUserProvideWranglerVersion: boolean;
+    secrets: string[];
+    workingDirectory: string;
+    CLOUDFLARE_API_TOKEN: string;
+    CLOUDFLARE_ACCOUNT_ID: string;
+    ENVIRONMENT: string;
+    VARS: string[];
+    COMMANDS: string[];
+    QUIET_MODE: boolean;
+    PACKAGE_MANAGER: string;
+    WRANGLER_OUTPUT_DIR: string;
+    GITHUB_TOKEN: string;
+}, {
+    WRANGLER_VERSION: string;
+    didUserProvideWranglerVersion: boolean;
+    secrets: string[];
+    workingDirectory: string;
+    CLOUDFLARE_API_TOKEN: string;
+    CLOUDFLARE_ACCOUNT_ID: string;
+    ENVIRONMENT: string;
+    VARS: string[];
+    COMMANDS: string[];
+    QUIET_MODE: boolean;
+    PACKAGE_MANAGER: string;
+    WRANGLER_OUTPUT_DIR: string;
+    GITHUB_TOKEN: string;
+}>;
+declare function main(config: WranglerActionConfig, packageManager: PackageManager): Promise<void>;
+declare function installWrangler(config: WranglerActionConfig, packageManager: PackageManager): Promise<void>;
+declare function authenticationSetup(config: WranglerActionConfig): void;
+declare function execCommands(config: WranglerActionConfig, packageManager: PackageManager, commands: string[], cmdType: string): Promise<void>;
+declare function uploadSecrets(config: WranglerActionConfig, packageManager: PackageManager): Promise<void>;
+declare function wranglerCommands(config: WranglerActionConfig, packageManager: PackageManager): Promise<void>;
+export { authenticationSetup, execCommands, info, installWrangler, main, uploadSecrets, wranglerCommands, };

dist/wranglerAction.test.d.ts

@@ -0,0 +1 @@
+export {};

dist/wranglerArtifactManager.d.ts

@@ -0,0 +1,200 @@
+import { z } from "zod";
+export type OutputEntryPagesDeployment = z.infer<typeof OutputEntryPagesDeployment>;
+declare const OutputEntryPagesDeployment: z.ZodObject<z.objectUtil.extendShape<{
+    version: z.ZodLiteral<1>;
+    type: z.ZodString;
+}, {
+    type: z.ZodLiteral<"pages-deploy-detailed">;
+    pages_project: z.ZodNullable<z.ZodString>;
+    deployment_id: z.ZodNullable<z.ZodString>;
+    url: z.ZodOptional<z.ZodString>;
+    alias: z.ZodOptional<z.ZodString>;
+    environment: z.ZodEnum<["production", "preview"]>;
+    production_branch: z.ZodOptional<z.ZodString>;
+    deployment_trigger: z.ZodOptional<z.ZodObject<{
+        metadata: z.ZodObject<{
+            /** Commit hash of the deployment trigger metadata for the pages project */
+            commit_hash: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            commit_hash: string;
+        }, {
+            commit_hash: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        metadata: {
+            commit_hash: string;
+        };
+    }, {
+        metadata: {
+            commit_hash: string;
+        };
+    }>>;
+}>, "strip", z.ZodTypeAny, {
+    type: "pages-deploy-detailed";
+    environment: "production" | "preview";
+    version: 1;
+    pages_project: string | null;
+    deployment_id: string | null;
+    url?: string | undefined;
+    alias?: string | undefined;
+    production_branch?: string | undefined;
+    deployment_trigger?: {
+        metadata: {
+            commit_hash: string;
+        };
+    } | undefined;
+}, {
+    type: "pages-deploy-detailed";
+    environment: "production" | "preview";
+    version: 1;
+    pages_project: string | null;
+    deployment_id: string | null;
+    url?: string | undefined;
+    alias?: string | undefined;
+    production_branch?: string | undefined;
+    deployment_trigger?: {
+        metadata: {
+            commit_hash: string;
+        };
+    } | undefined;
+}>;
+export type OutputEntryDeployment = z.infer<typeof OutputEntryDeployment>;
+declare const OutputEntryDeployment: z.ZodObject<z.objectUtil.extendShape<{
+    version: z.ZodLiteral<1>;
+    type: z.ZodString;
+}, {
+    type: z.ZodLiteral<"deploy">;
+    /** A list of URLs that represent the HTTP triggers associated with this deployment */
+    /** basically, for wrangler-action purposes this is the deployment urls */
+    targets: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}>, "strip", z.ZodTypeAny, {
+    type: "deploy";
+    version: 1;
+    targets?: string[] | undefined;
+}, {
+    type: "deploy";
+    version: 1;
+    targets?: string[] | undefined;
+}>;
+export type OutputEntryVersionUpload = z.infer<typeof OutputEntryVersionUpload>;
+declare const OutputEntryVersionUpload: z.ZodObject<z.objectUtil.extendShape<{
+    version: z.ZodLiteral<1>;
+    type: z.ZodString;
+}, {
+    type: z.ZodLiteral<"version-upload">;
+    /** The preview URL associated with this version upload */
+    preview_url: z.ZodOptional<z.ZodString>;
+}>, "strip", z.ZodTypeAny, {
+    type: "version-upload";
+    version: 1;
+    preview_url?: string | undefined;
+}, {
+    type: "version-upload";
+    version: 1;
+    preview_url?: string | undefined;
+}>;
+export type SupportedOutputEntry = z.infer<typeof SupportedOutputEntry>;
+declare const SupportedOutputEntry: z.ZodDiscriminatedUnion<"type", [z.ZodObject<z.objectUtil.extendShape<{
+    version: z.ZodLiteral<1>;
+    type: z.ZodString;
+}, {
+    type: z.ZodLiteral<"pages-deploy-detailed">;
+    pages_project: z.ZodNullable<z.ZodString>;
+    deployment_id: z.ZodNullable<z.ZodString>;
+    url: z.ZodOptional<z.ZodString>;
+    alias: z.ZodOptional<z.ZodString>;
+    environment: z.ZodEnum<["production", "preview"]>;
+    production_branch: z.ZodOptional<z.ZodString>;
+    deployment_trigger: z.ZodOptional<z.ZodObject<{
+        metadata: z.ZodObject<{
+            /** Commit hash of the deployment trigger metadata for the pages project */
+            commit_hash: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            commit_hash: string;
+        }, {
+            commit_hash: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        metadata: {
+            commit_hash: string;
+        };
+    }, {
+        metadata: {
+            commit_hash: string;
+        };
+    }>>;
+}>, "strip", z.ZodTypeAny, {
+    type: "pages-deploy-detailed";
+    environment: "production" | "preview";
+    version: 1;
+    pages_project: string | null;
+    deployment_id: string | null;
+    url?: string | undefined;
+    alias?: string | undefined;
+    production_branch?: string | undefined;
+    deployment_trigger?: {
+        metadata: {
+            commit_hash: string;
+        };
+    } | undefined;
+}, {
+    type: "pages-deploy-detailed";
+    environment: "production" | "preview";
+    version: 1;
+    pages_project: string | null;
+    deployment_id: string | null;
+    url?: string | undefined;
+    alias?: string | undefined;
+    production_branch?: string | undefined;
+    deployment_trigger?: {
+        metadata: {
+            commit_hash: string;
+        };
+    } | undefined;
+}>, z.ZodObject<z.objectUtil.extendShape<{
+    version: z.ZodLiteral<1>;
+    type: z.ZodString;
+}, {
+    type: z.ZodLiteral<"deploy">;
+    /** A list of URLs that represent the HTTP triggers associated with this deployment */
+    /** basically, for wrangler-action purposes this is the deployment urls */
+    targets: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}>, "strip", z.ZodTypeAny, {
+    type: "deploy";
+    version: 1;
+    targets?: string[] | undefined;
+}, {
+    type: "deploy";
+    version: 1;
+    targets?: string[] | undefined;
+}>, z.ZodObject<z.objectUtil.extendShape<{
+    version: z.ZodLiteral<1>;
+    type: z.ZodString;
+}, {
+    type: z.ZodLiteral<"version-upload">;
+    /** The preview URL associated with this version upload */
+    preview_url: z.ZodOptional<z.ZodString>;
+}>, "strip", z.ZodTypeAny, {
+    type: "version-upload";
+    version: 1;
+    preview_url?: string | undefined;
+}, {
+    type: "version-upload";
+    version: 1;
+    preview_url?: string | undefined;
+}>]>;
+/**
+ * Parses file names in a directory to find wrangler artifact files
+ *
+ * @param artifactDirectory
+ * @returns All artifact files from the directory
+ */
+export declare function getWranglerArtifacts(artifactDirectory: string): Promise<string[]>;
+/**
+ * Searches for a supported wrangler OutputEntry
+ *
+ * @param artifactDirectory
+ * @returns The first SupportedOutputEntry found within a wrangler artifact directory
+ */
+export declare function getOutputEntry(artifactDirectory: string): Promise<SupportedOutputEntry | null>;
+export {};

dist/wranglerArtifactManager.test.d.ts

@@ -0,0 +1 @@
+export {};

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wrangler-action",
-	"version": "3.14.0",
+	"version": "3.13.1",
 	"description": "GitHub Action to use [Wrangler](https://developers.cloudflare.com/workers/cli-wrangler/).",
 	"author": "wrangler@cloudflare.com",
 	"license": "MIT OR Apache-2.0",

src/wranglerAction.test.ts

@@ -1,7 +1,7 @@
 import * as core from "@actions/core";
 import * as exec from "@actions/exec";
 import { describe, expect, it, vi } from "vitest";
-import { installWrangler, uploadSecrets } from "./wranglerAction";
+import { installWrangler } from "./wranglerAction";
 import { getTestConfig } from "./test/test-utils";
 
 describe("installWrangler", () => {
@@ -76,90 +76,3 @@ describe("installWrangler", () => {
 		expect(infoSpy).toBeCalledWith("✅ Wrangler installed");
 	});
 });
-
-describe("uploadSecrets", () => {
-	const testPackageManager = {
-		install: "npm i",
-		exec: "npx",
-		execNoInstall: "npx --no-install",
-	};
-
-	it("WRANGLER_VERSION < 3.4.0 uses wrangler secret put", async () => {
-		vi.stubEnv("FAKE_SECRET", "FAKE_VALUE");
-		const testConfig = getTestConfig({
-			config: {
-				WRANGLER_VERSION: "3.3.0",
-				didUserProvideWranglerVersion: true,
-				secrets: ["FAKE_SECRET"],
-			},
-		});
-		vi.spyOn(exec, "exec").mockImplementation(async (cmd, args) => {
-			expect(cmd).toBe("npx");
-			expect(args).toStrictEqual([
-				"wrangler",
-				"secret",
-				"put",
-				"FAKE_SECRET",
-				"--env",
-				"dev",
-			]);
-			return 0;
-		});
-		const startGroup = vi.spyOn(core, "startGroup");
-		const endGroup = vi.spyOn(core, "endGroup");
-
-		await uploadSecrets(testConfig, testPackageManager);
-		expect(startGroup).toBeCalledWith("🔑 Uploading secrets...");
-		expect(endGroup).toHaveBeenCalledOnce();
-	});
-
-	it("WRANGLER_VERSION < 3.60.0 uses wrangler secret:bulk", async () => {
-		vi.stubEnv("FAKE_SECRET", "FAKE_VALUE");
-		const testConfig = getTestConfig({
-			config: {
-				WRANGLER_VERSION: "3.59.0",
-				didUserProvideWranglerVersion: true,
-				secrets: ["FAKE_SECRET"],
-			},
-		});
-		vi.spyOn(exec, "exec").mockImplementation(async (cmd, args) => {
-			expect(cmd).toBe("npx");
-			expect(args).toStrictEqual(["wrangler", "secret:bulk", "--env", "dev"]);
-			return 0;
-		});
-		const startGroup = vi.spyOn(core, "startGroup");
-		const endGroup = vi.spyOn(core, "endGroup");
-
-		await uploadSecrets(testConfig, testPackageManager);
-		expect(startGroup).toBeCalledWith("🔑 Uploading secrets...");
-		expect(endGroup).toHaveBeenCalledOnce();
-	});
-
-	it("WRANGLER_VERSION 3.61.0 uses wrangler secret bulk", async () => {
-		vi.stubEnv("FAKE_SECRET", "FAKE_VALUE");
-		const testConfig = getTestConfig({
-			config: {
-				WRANGLER_VERSION: "3.61.0",
-				didUserProvideWranglerVersion: true,
-				secrets: ["FAKE_SECRET"],
-			},
-		});
-		vi.spyOn(exec, "exec").mockImplementation(async (cmd, args) => {
-			expect(cmd).toBe("npx");
-			expect(args).toStrictEqual([
-				"wrangler",
-				"secret",
-				"bulk",
-				"--env",
-				"dev",
-			]);
-			return 0;
-		});
-		const startGroup = vi.spyOn(core, "startGroup");
-		const endGroup = vi.spyOn(core, "endGroup");
-
-		await uploadSecrets(testConfig, testPackageManager);
-		expect(startGroup).toBeCalledWith("🔑 Uploading secrets...");
-		expect(endGroup).toHaveBeenCalledOnce();
-	});
-});

src/wranglerAction.ts

@@ -13,7 +13,6 @@ import { exec, execShell } from "./exec";
 import { PackageManager } from "./packageManagers";
 import { error, info, semverCompare } from "./utils";
 import { handleCommandOutputParsing } from "./commandOutputParsing";
-import semverLt from "semver/functions/lt";
 
 export type WranglerActionConfig = z.infer<typeof wranglerActionConfig>;
 export const wranglerActionConfig = z.object({
@@ -266,11 +265,7 @@ async function uploadSecrets(
 			);
 		}
 
-		let args = ["wrangler", "secret", "bulk"];
-		// if we're on a WRANGLER_VERSION prior to 3.60.0 use wrangler secret:bulk
-		if (semverLt(config["WRANGLER_VERSION"], "3.60.0")) {
-			args = ["wrangler", "secret:bulk"];
-		}
+		const args = ["wrangler", "secret:bulk"];
 
 		if (environment) {
 			args.push("--env", environment);