Merge pull request #2507 from Harikrishnan1367709/Allow-setting-a-title/description-for-deployments-via-API-or-CLI-#1485-Harikrishnan

feat: Add custom title/description support for API/CLI deployments (#1485)
This commit is contained in:
Mauricio Siu
2025-09-06 14:00:26 -06:00
committed by GitHub
6 changed files with 64 additions and 28 deletions
+6 -6
View File
@@ -3,8 +3,8 @@ import { z } from "zod";
export const deployJobSchema = z.discriminatedUnion("applicationType", [ export const deployJobSchema = z.discriminatedUnion("applicationType", [
z.object({ z.object({
applicationId: z.string(), applicationId: z.string(),
titleLog: z.string(), titleLog: z.string().optional(),
descriptionLog: z.string(), descriptionLog: z.string().optional(),
server: z.boolean().optional(), server: z.boolean().optional(),
type: z.enum(["deploy", "redeploy"]), type: z.enum(["deploy", "redeploy"]),
applicationType: z.literal("application"), applicationType: z.literal("application"),
@@ -12,8 +12,8 @@ export const deployJobSchema = z.discriminatedUnion("applicationType", [
}), }),
z.object({ z.object({
composeId: z.string(), composeId: z.string(),
titleLog: z.string(), titleLog: z.string().optional(),
descriptionLog: z.string(), descriptionLog: z.string().optional(),
server: z.boolean().optional(), server: z.boolean().optional(),
type: z.enum(["deploy", "redeploy"]), type: z.enum(["deploy", "redeploy"]),
applicationType: z.literal("compose"), applicationType: z.literal("compose"),
@@ -22,8 +22,8 @@ export const deployJobSchema = z.discriminatedUnion("applicationType", [
z.object({ z.object({
applicationId: z.string(), applicationId: z.string(),
previewDeploymentId: z.string(), previewDeploymentId: z.string(),
titleLog: z.string(), titleLog: z.string().optional(),
descriptionLog: z.string(), descriptionLog: z.string().optional(),
server: z.boolean().optional(), server: z.boolean().optional(),
type: z.enum(["deploy"]), type: z.enum(["deploy"]),
applicationType: z.literal("application-preview"), applicationType: z.literal("application-preview"),
+10 -10
View File
@@ -18,14 +18,14 @@ export const deploy = async (job: DeployJob) => {
if (job.type === "redeploy") { if (job.type === "redeploy") {
await rebuildRemoteApplication({ await rebuildRemoteApplication({
applicationId: job.applicationId, applicationId: job.applicationId,
titleLog: job.titleLog, titleLog: job.titleLog || "Rebuild deployment",
descriptionLog: job.descriptionLog, descriptionLog: job.descriptionLog || "",
}); });
} else if (job.type === "deploy") { } else if (job.type === "deploy") {
await deployRemoteApplication({ await deployRemoteApplication({
applicationId: job.applicationId, applicationId: job.applicationId,
titleLog: job.titleLog, titleLog: job.titleLog || "Manual deployment",
descriptionLog: job.descriptionLog, descriptionLog: job.descriptionLog || "",
}); });
} }
} }
@@ -38,14 +38,14 @@ export const deploy = async (job: DeployJob) => {
if (job.type === "redeploy") { if (job.type === "redeploy") {
await rebuildRemoteCompose({ await rebuildRemoteCompose({
composeId: job.composeId, composeId: job.composeId,
titleLog: job.titleLog, titleLog: job.titleLog || "Rebuild deployment",
descriptionLog: job.descriptionLog, descriptionLog: job.descriptionLog || "",
}); });
} else if (job.type === "deploy") { } else if (job.type === "deploy") {
await deployRemoteCompose({ await deployRemoteCompose({
composeId: job.composeId, composeId: job.composeId,
titleLog: job.titleLog, titleLog: job.titleLog || "Manual deployment",
descriptionLog: job.descriptionLog, descriptionLog: job.descriptionLog || "",
}); });
} }
} }
@@ -57,8 +57,8 @@ export const deploy = async (job: DeployJob) => {
if (job.type === "deploy") { if (job.type === "deploy") {
await deployRemotePreviewApplication({ await deployRemotePreviewApplication({
applicationId: job.applicationId, applicationId: job.applicationId,
titleLog: job.titleLog, titleLog: job.titleLog || "Preview Deployment",
descriptionLog: job.descriptionLog, descriptionLog: job.descriptionLog || "",
previewDeploymentId: job.previewDeploymentId, previewDeploymentId: job.previewDeploymentId,
}); });
} }
@@ -40,8 +40,10 @@ import {
import { db } from "@/server/db"; import { db } from "@/server/db";
import { import {
apiCreateApplication, apiCreateApplication,
apiDeployApplication,
apiFindMonitoringStats, apiFindMonitoringStats,
apiFindOneApplication, apiFindOneApplication,
apiRedeployApplication,
apiReloadApplication, apiReloadApplication,
apiSaveBitbucketProvider, apiSaveBitbucketProvider,
apiSaveBuildType, apiSaveBuildType,
@@ -306,7 +308,7 @@ export const applicationRouter = createTRPCRouter({
}), }),
redeploy: protectedProcedure redeploy: protectedProcedure
.input(apiFindOneApplication) .input(apiRedeployApplication)
.mutation(async ({ input, ctx }) => { .mutation(async ({ input, ctx }) => {
const application = await findApplicationById(input.applicationId); const application = await findApplicationById(input.applicationId);
if ( if (
@@ -320,8 +322,8 @@ export const applicationRouter = createTRPCRouter({
} }
const jobData: DeploymentJob = { const jobData: DeploymentJob = {
applicationId: input.applicationId, applicationId: input.applicationId,
titleLog: "Rebuild deployment", titleLog: input.title || "Rebuild deployment",
descriptionLog: "", descriptionLog: input.description || "",
type: "redeploy", type: "redeploy",
applicationType: "application", applicationType: "application",
server: !!application.serverId, server: !!application.serverId,
@@ -670,7 +672,7 @@ export const applicationRouter = createTRPCRouter({
return true; return true;
}), }),
deploy: protectedProcedure deploy: protectedProcedure
.input(apiFindOneApplication) .input(apiDeployApplication)
.mutation(async ({ input, ctx }) => { .mutation(async ({ input, ctx }) => {
const application = await findApplicationById(input.applicationId); const application = await findApplicationById(input.applicationId);
if ( if (
@@ -684,8 +686,8 @@ export const applicationRouter = createTRPCRouter({
} }
const jobData: DeploymentJob = { const jobData: DeploymentJob = {
applicationId: input.applicationId, applicationId: input.applicationId,
titleLog: "Manual deployment", titleLog: input.title || "Manual deployment",
descriptionLog: "", descriptionLog: input.description || "",
type: "deploy", type: "deploy",
applicationType: "application", applicationType: "application",
server: !!application.serverId, server: !!application.serverId,
+8 -6
View File
@@ -48,9 +48,11 @@ import { db } from "@/server/db";
import { import {
apiCreateCompose, apiCreateCompose,
apiDeleteCompose, apiDeleteCompose,
apiDeployCompose,
apiFetchServices, apiFetchServices,
apiFindCompose, apiFindCompose,
apiRandomizeCompose, apiRandomizeCompose,
apiRedeployCompose,
apiUpdateCompose, apiUpdateCompose,
compose as composeTable, compose as composeTable,
} from "@/server/db/schema"; } from "@/server/db/schema";
@@ -367,7 +369,7 @@ export const composeRouter = createTRPCRouter({
}), }),
deploy: protectedProcedure deploy: protectedProcedure
.input(apiFindCompose) .input(apiDeployCompose)
.mutation(async ({ input, ctx }) => { .mutation(async ({ input, ctx }) => {
const compose = await findComposeById(input.composeId); const compose = await findComposeById(input.composeId);
@@ -382,10 +384,10 @@ export const composeRouter = createTRPCRouter({
} }
const jobData: DeploymentJob = { const jobData: DeploymentJob = {
composeId: input.composeId, composeId: input.composeId,
titleLog: "Manual deployment", titleLog: input.title || "Manual deployment",
type: "deploy", type: "deploy",
applicationType: "compose", applicationType: "compose",
descriptionLog: "", descriptionLog: input.description || "",
server: !!compose.serverId, server: !!compose.serverId,
}; };
@@ -404,7 +406,7 @@ export const composeRouter = createTRPCRouter({
); );
}), }),
redeploy: protectedProcedure redeploy: protectedProcedure
.input(apiFindCompose) .input(apiRedeployCompose)
.mutation(async ({ input, ctx }) => { .mutation(async ({ input, ctx }) => {
const compose = await findComposeById(input.composeId); const compose = await findComposeById(input.composeId);
if ( if (
@@ -418,10 +420,10 @@ export const composeRouter = createTRPCRouter({
} }
const jobData: DeploymentJob = { const jobData: DeploymentJob = {
composeId: input.composeId, composeId: input.composeId,
titleLog: "Rebuild deployment", titleLog: input.title || "Rebuild deployment",
type: "redeploy", type: "redeploy",
applicationType: "compose", applicationType: "compose",
descriptionLog: "", descriptionLog: input.description || "",
server: !!compose.serverId, server: !!compose.serverId,
}; };
if (IS_CLOUD && compose.serverId) { if (IS_CLOUD && compose.serverId) {
@@ -328,6 +328,26 @@ export const apiFindOneApplication = createSchema
}) })
.required(); .required();
export const apiDeployApplication = createSchema
.pick({
applicationId: true,
})
.extend({
applicationId: z.string().min(1),
title: z.string().optional(),
description: z.string().optional(),
});
export const apiRedeployApplication = createSchema
.pick({
applicationId: true,
})
.extend({
applicationId: z.string().min(1),
title: z.string().optional(),
description: z.string().optional(),
});
export const apiReloadApplication = createSchema export const apiReloadApplication = createSchema
.pick({ .pick({
appName: true, appName: true,
+12
View File
@@ -181,6 +181,18 @@ export const apiFindCompose = z.object({
composeId: z.string().min(1), composeId: z.string().min(1),
}); });
export const apiDeployCompose = z.object({
composeId: z.string().min(1),
title: z.string().optional(),
description: z.string().optional(),
});
export const apiRedeployCompose = z.object({
composeId: z.string().min(1),
title: z.string().optional(),
description: z.string().optional(),
});
export const apiDeleteCompose = z.object({ export const apiDeleteCompose = z.object({
composeId: z.string().min(1), composeId: z.string().min(1),
deleteVolumes: z.boolean(), deleteVolumes: z.boolean(),