fix: update cron field schema description and fix formatting

blink-so[bot] · blink-so[bot] · commit e998cb2241c2 · 2025-06-04T14:55:12.000Z
- Updated the cron field description in provider/script.go to include detailed 6-field format explanation
- Fixed formatting issues in documentation (removed extra spaces before comments)
- Regenerated documentation to ensure consistency between schema and docs
- This ensures the documentation generation preserves the detailed cron description instead of reverting to generic text
diff --git a/docs/resources/script.md b/docs/resources/script.md
@@ -47,7 +47,7 @@ resource "coder_script" "nightly_update" {
   agent_id     = coder_agent.dev.agent_id
   display_name = "Nightly update"
   icon         = "/icon/database.svg"
-  cron         = "0 0 22 * * *"  # Run at 22:00 (10 PM) every day
+  cron         = "0 0 22 * * *" # Run at 22:00 (10 PM) every day
   script       = <<EOF
     #!/bin/sh
     echo "Running nightly update"
@@ -59,7 +59,7 @@ resource "coder_script" "every_5_minutes" {
   agent_id     = coder_agent.dev.agent_id
   display_name = "Health check"
   icon         = "/icon/heart.svg"
-  cron         = "0 */5 * * * *"  # Run every 5 minutes
+  cron         = "0 */5 * * * *" # Run every 5 minutes
   script       = <<EOF
     #!/bin/sh
     echo "Health check at $(date)"
diff --git a/provider/script.go b/provider/script.go
@@ -99,7 +99,7 @@ func scriptResource() *schema.Resource {
 				ForceNew:    true,
 				Type:        schema.TypeString,
 				Optional:    true,
-				Description: "The cron schedule to run the script on. This is a cron expression.",
+				Description: "The cron schedule to run the script on. This uses a 6-field cron expression format: `seconds minutes hours day-of-month month day-of-week`. Note that this differs from the standard Unix 5-field format by including seconds as the first field. Examples: `\"0 0 22 * * *\"` (daily at 10 PM), `\"0 */5 * * * *\"` (every 5 minutes), `\"30 0 9 * * 1-5\"` (weekdays at 9:30 AM).",
 				ValidateFunc: func(i interface{}, _ string) ([]string, []error) {
 					v, ok := i.(string)
 					if !ok {
