code-comment reminder for feature flags (#3512)

A friendly reminder, stemming from the discussion in earthly/earthly#3510 (comment) Signed-off-by: Alex Couture-Beil <[email protected]>
earthly · Nov 20, 2023 · ef4fc54 · ef4fc54
1 parent 6610b73
commit ef4fc54
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/ast/commandflag/flags.go b/ast/commandflag/flags.go
@@ -4,6 +4,10 @@ import (
 	"time"
 )
 
+// NOTE: Any new flags must be accompanied by the introduction of a new `VERSION` feature flag.
+// This applies to new features which do **not** break backwards compatibility, which is needed
+// to ensure an Earthfile that uses `VERSION 0.7` can be built by **any** of the earthly-v0.7.x binaries.
+
 type IfOpts struct {
 	Privileged bool     `long:"privileged" description:"Enable privileged mode"`
 	WithSSH    bool     `long:"ssh" description:"Make available the SSH agent of the host"`