📃 add docs to featureflags

Signed-off-by: Dominik Richter <dominik.richter@gmail.com>

Author: arlimus

featureflags.go

@@ -1,20 +1,15 @@
 // Copyright (c) Mondoo, Inc.
 // SPDX-License-Identifier: BUSL-1.1
 
-//
-// In this file we introduce feature flags. They help us activate optional
-// features on requests.
-//
-// Features can only be activated, never deactivated. Features are efficiently encoded.
-// They are introduced at a given version and destined to be removed at a later version.
-// Please mark them accordingly. Feature flags are short term contextual information.
+// In this file we introduce feature flags.
+// - Please configure any new feature-flags in features.yaml
+// - To generate, use go generate. See the call to go:generate below
+// - To learn more about the generator, look at ./utils/featureflags/main.go header
 //
 // Example usage:
 //
 // features := []Feature{ MassResolver, LiveQueries }
-//
 // features.IsActive( MassResolver )   // true
-//
 
 package cnquery
 

features.go

@@ -1,3 +1,6 @@
+# Copyright (c) Mondoo, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
 Features:
 - desc: "Resolve similar queries the same way. If 100 assets have the same dependent
     queries and overrides, \nthey create the same resolved plan. Cannot be used with
@@ -25,8 +28,8 @@ Features:
   id: K8sNodeDiscovery
   idx: 4
   start: v6.12
-  status: unknown
-- desc: ""
+  status: sunset, should be done via discovery code instead
+- desc: Add context to assets for e.g. Terraform
   end: v12.0
   id: MQLAssetContext
   idx: 5

features.yaml

@@ -1,6 +1,24 @@
 // Copyright (c) Mondoo, Inc.
 // SPDX-License-Identifier: BUSL-1.1
 
+// Generate a go source file with feature-flags and helper vars.
+//
+// You configure feature-flags in YAML. Here is an example:
+//
+// - desc: Allows MQL to use variable references across blocks. Fully changes the compiled code.
+//   end: v7.0
+//   id: PiperCode
+//   start: v5.x
+//   status: default
+//   idx: 2           # optional, will be generated
+//
+// Status can be:
+// - builtin: features that are completed and have been built into the code, but shouldn't be used (or set) anymore
+// - sunset: features that are completed but have not been built into the code, please don't use them anymore
+// - new: features that are now available to be used and aren't active by default
+// - default: features that are available and turned on by default (you can still turn them off)
+// - unknown: try not to have any unknown features, we don't know what's going on with these but don't use them
+
 package main
 
 import (
@@ -18,17 +36,11 @@ type (
 		Features []*feature
 	}
 	feature struct {
-		Id    string `json:"id"`
-		Idx   int    `json:"idx"`
-		Start string `json:"start"`
-		End   string `json:"end,omitempty"`
-		Desc  string `json:"desc"`
-		// Status can be:
-		// - builtin: features that are completed and have been built into the code, but shouldn't be used (or set) anymore
-		// - sunset: features that are completed but have not been built into the code, please don't use them anymore
-		// - new: features that are now available to be used and aren't active by default
-		// - default: features that are available and turned on by default (you can still turn them off)
-		// - unknown: try not to have any unknown features, we don't know what's going on with these but don't use them
+		Id     string `json:"id"`
+		Idx    int    `json:"idx"`
+		Start  string `json:"start"`
+		End    string `json:"end,omitempty"`
+		Desc   string `json:"desc"`
 		Status string `json:"status,omitempty"`
 	}
 )