Hiding custom recipes

custom-recipes/buildernet/mkosi/playground.yaml

@@ -1,5 +1,6 @@
 base: buildernet
-description: Deploy the stack with the BuilderNet mkosi image (QEMU)
+description: Deploy the stack with the BuilderNet mkosi image (QEMU) - check out the README before running!
+hidden: true
 
 recipe:
   builder-vm:

main.go

@@ -474,8 +474,11 @@ var recipesCmd = &cobra.Command{
 		}
 		whiteTitleColor.Println("Custom Recipes:")
 		for _, cr := range customRecipes {
-			fmt.Println("  " + customRecipesColor.Sprint(cr))
 			info, err := playground.GetCustomRecipeInfo(cr, recipes)
+			if err == nil && info.Hidden {
+				continue
+			}
+			fmt.Println("  " + customRecipesColor.Sprint(cr))
 			if err == nil {
 				if info.Description != "" {
 					descriptionColor.Add(color.Bold).Printf("    %s\n", info.Description)
@@ -575,6 +578,10 @@ func main() {
 	var customRecipes []playground.Recipe
 
 	for _, crName := range customRecipeNames {
+		info, err := playground.GetCustomRecipeInfo(crName, recipes)
+		if err == nil && info.Hidden {
+			continue // Skip hidden custom recipes
+		}
 		customRecipe, cleanup, err := playground.LoadCustomRecipe(crName, recipes)
 		if err != nil {
 			continue // Skip invalid custom recipes

playground/custom_recipes.go

@@ -56,6 +56,7 @@ type CustomRecipeInfo struct {
 	Name               string
 	Description        string
 	Base               string
+	Hidden             bool
 	ModifiedComponents []string
 	NewComponents      []string
 }
@@ -94,6 +95,7 @@ func GetCustomRecipeInfo(customRecipeName string, baseRecipes []Recipe) (*Custom
 		Name:        customRecipeName,
 		Base:        config.Base,
 		Description: config.Description,
+		Hidden:      config.Hidden,
 	}
 
 	// Find the base recipe to get its components

playground/recipe_yaml.go

@@ -22,6 +22,9 @@ type YAMLRecipeConfig struct {
 	// Description is an optional description of the recipe
 	Description string `yaml:"description,omitempty"`
 
+	// Hidden indicates this recipe should be excluded from listings and automated discovery
+	Hidden bool `yaml:"hidden,omitempty"`
+
 	// Setup is a list of shell commands to run before any services are launched.
 	// Commands run sequentially in the recipe's directory; each must exit 0.
 	Setup []string `yaml:"setup,omitempty"`