Merge pull request #4371 from Dokploy/feat/schedule-description

feat(schedules): add optional description field

apps/dokploy/components/dashboard/application/schedules/handle-schedules.tsx

@@ -80,6 +80,7 @@ export const commonCronExpressions = [
 const formSchema = z
 	.object({
 		name: z.string().min(1, "Name is required"),
+		description: z.string().optional(),
 		cronExpression: z.string().min(1, "Cron expression is required"),
 		shellType: z.enum(["bash", "sh"]).default("bash"),
 		command: z.string(),
@@ -224,6 +225,7 @@ export const HandleSchedules = ({ id, scheduleId, scheduleType }: Props) => {
 		resolver: standardSchemaResolver(formSchema),
 		defaultValues: {
 			name: "",
+			description: "",
 			cronExpression: "",
 			shellType: "bash",
 			command: "",
@@ -263,6 +265,7 @@ export const HandleSchedules = ({ id, scheduleId, scheduleType }: Props) => {
 		if (scheduleId && schedule) {
 			form.reset({
 				name: schedule.name,
+				description: schedule.description || "",
 				cronExpression: schedule.cronExpression,
 				shellType: schedule.shellType,
 				command: schedule.command,
@@ -479,6 +482,26 @@ export const HandleSchedules = ({ id, scheduleId, scheduleType }: Props) => {
 							)}
 						/>
 
+						<FormField
+							control={form.control}
+							name="description"
+							render={({ field }) => (
+								<FormItem>
+									<FormLabel>Description</FormLabel>
+									<FormControl>
+										<Input
+											placeholder="Backs up the database every day at midnight"
+											{...field}
+										/>
+									</FormControl>
+									<FormDescription>
+										Optional description of what this schedule does
+									</FormDescription>
+									<FormMessage />
+								</FormItem>
+							)}
+						/>
+
 						<ScheduleFormField
 							name="cronExpression"
 							formControl={form.control}

apps/dokploy/components/dashboard/application/schedules/show-schedules.tsx

@@ -125,6 +125,11 @@ export const ShowSchedules = ({ id, scheduleType = "application" }: Props) => {
 													{schedule.enabled ? "Enabled" : "Disabled"}
 												</Badge>
 											</div>
+											{schedule.description && (
+												<p className="text-xs text-muted-foreground/70 [overflow-wrap:anywhere] line-clamp-2">
+													{schedule.description}
+												</p>
+											)}
 											<div className="flex items-center gap-2 text-sm text-muted-foreground flex-wrap">
 												<Badge
 													variant="outline"

apps/dokploy/drizzle/0166_nosy_slapstick.sql

@@ -0,0 +1 @@
+ALTER TABLE "schedule" ADD COLUMN "description" text;

apps/dokploy/drizzle/meta/_journal.json

@@ -1163,6 +1163,13 @@
       "when": 1775845419261,
       "tag": "0165_abnormal_greymalkin",
       "breakpoints": true
+    },
+    {
+      "idx": 166,
+      "version": "7",
+      "when": 1778303519111,
+      "tag": "0166_nosy_slapstick",
+      "breakpoints": true
     }
   ]
 }

packages/server/src/db/schema/schedule.ts

@@ -24,6 +24,7 @@ export const schedules = pgTable("schedule", {
 		.primaryKey()
 		.$defaultFn(() => nanoid()),
 	name: text("name").notNull(),
+	description: text("description"),
 	cronExpression: text("cronExpression").notNull(),
 	appName: text("appName")
 		.notNull()