feat: ✨ added new DEPLOYMENT_NAME input param for the action

Author: VoloshchenkoAl

.changeset/selfish-socks-sing.md

@@ -0,0 +1,5 @@
+---
+"wrangler-action": minor
+---
+
+Added the new DEPLOYMENT_NAME input param for the action. This param is responsible for the custom name of the GitHub Deployment

README.md

@@ -186,6 +186,8 @@ jobs:
           command: pages deploy YOUR_DIST_FOLDER --project-name=example
           # Optional: Enable this if you want to have GitHub Deployments triggered
           gitHubToken: ${{ secrets.GITHUB_TOKEN }}
+          # Optional: Add a custom deployment name for GitHub Deployments
+          deploymentName: Example Project
 ```
 
 ### Deploying on a schedule

src/commandOutputParsing.ts

@@ -125,7 +125,7 @@ function handleVersionsOutputCommand(config: WranglerActionConfig) {
 	);
 }
 
-function handleDeprectatedStdoutParsing(
+function handleDeprecatedStdoutParsing(
 	config: WranglerActionConfig,
 	command: string,
 	stdOut: string,
@@ -162,7 +162,7 @@ export async function handleCommandOutputParsing(
 
 	if (outputEntry === null) {
 		// if no outputEntry found, fallback to deprecated stdOut parsing
-		handleDeprectatedStdoutParsing(config, command, stdOut);
+		handleDeprecatedStdoutParsing(config, command, stdOut);
 		return;
 	}
 

src/index.ts

@@ -26,7 +26,8 @@ const config: WranglerActionConfig = {
 		tmpdir(),
 		`wranglerArtifacts-${crypto.randomUUID()}`,
 	)}`,
-	GITHUB_TOKEN: getInput("gitHubToken", { required: false }),
+	GITHUB_TOKEN: getInput("gitHubToken"),
+	DEPLOYMENT_NAME: getInput("deploymentName"),
 } as const;
 
 const packageManager = getPackageManager(config.PACKAGE_MANAGER, {

src/service/github.ts

@@ -95,14 +95,15 @@ export async function createGitHubDeploymentAndJobSummary(
 		pagesArtifactFields.deployment_trigger
 	) {
 		const octokit = getOctokit(config.GITHUB_TOKEN);
+		const environment = config.DEPLOYMENT_NAME || pagesArtifactFields.environment;
 		const [createGitHubDeploymentRes, createJobSummaryRes] =
 			await Promise.allSettled([
 				createGitHubDeployment({
 					config,
 					octokit,
+					environment,
 					deploymentUrl: pagesArtifactFields.url,
 					productionBranch: pagesArtifactFields.production_branch,
-					environment: pagesArtifactFields.environment,
 					deploymentId: pagesArtifactFields.deployment_id,
 					projectName: pagesArtifactFields.pages_project,
 				}),

src/wranglerAction.ts

@@ -29,6 +29,7 @@ export const wranglerActionConfig = z.object({
 	PACKAGE_MANAGER: z.string(),
 	WRANGLER_OUTPUT_DIR: z.string(),
 	GITHUB_TOKEN: z.string(),
+	DEPLOYMENT_NAME: z.string().optional(),
 });
 
 function startGroup(config: WranglerActionConfig, name: string): void {