Document zero behaviour

evgeniy-scherbina · evgeniy-scherbina · commit bce12deef124 · 2025-05-09T20:49:32.000Z
diff --git a/coderd/database/querier_test.go b/coderd/database/querier_test.go
@@ -4472,6 +4472,13 @@ func TestGetPresetsAtFailureLimit(t *testing.T) {
 			hardLimit:       3,
 			expHitHardLimit: false,
 		},
+		// hardLimit set to zero, implicitly disables the hard limit.
+		{
+			name:            "despite 5 failed builds, the hard limit is not reached because it's disabled.",
+			buildSuccesses:  []bool{false, false, false, false, false},
+			hardLimit:       0,
+			expHitHardLimit: false,
+		},
 	}
 
 	for _, tc := range testCases {
diff --git a/codersdk/deployment.go b/codersdk/deployment.go
@@ -811,6 +811,7 @@ type PrebuildsConfig struct {
 	// FailureHardLimit defines the maximum number of consecutive failed prebuild attempts allowed
 	// before a preset is considered to be in a hard limit state. When a preset hits this limit,
 	// no new prebuilds will be created until the limit is reset.
+	// FailureHardLimit is disabled when set to zero.
 	FailureHardLimit serpent.Int64 `json:"failure_hard_limit" typescript:"failure_hard_limit"`
 }
 
@@ -3093,7 +3094,7 @@ Write out the current server config as YAML to stdout.`,
 		},
 		{
 			Name:        "Failure Hard Limit",
-			Description: "Maximum number of consecutive failed prebuilds before a preset hits the hard limit.",
+			Description: "Maximum number of consecutive failed prebuilds before a preset hits the hard limit. FailureHardLimit is disabled when set to zero.",
 			Flag:        "workspace-prebuilds-failure-hard-limit",
 			Env:         "CODER_WORKSPACE_PREBUILDS_FAILURE_HARD_LIMIT",
 			Value:       &c.Prebuilds.FailureHardLimit,
