chore: Make schema file optional for now (#9)

Co-authored-by: Claude <[email protected]>

Author: mvicknr

README.md

@@ -2,7 +2,7 @@
 
 # Agent Metadata Action
 
-A GitHub Action that reads agent configuration metadata from the calling repository. This action parses the `.fleetControl/configurationDefinitions.yml` file and makes the configuration data available for downstream workflow steps.
+A GitHub Action that reads agent configuration metadata from the calling repository. This action parses the `.fleetControl/configurationDefinitions.yml` file and makes the configuration data available in New Relic.
 
 ## Installation
 
@@ -62,17 +62,17 @@ For the agent scenario, the action expects a YAML file at `.fleetControl/configu
 
 ```yaml
 configurationDefinitions:
-  - platform: "kubernetes"  # or "host"
+  - platform: "kubernetes"  # or "host" or "all" if there is no distinction
     description: "Description of the configuration"
     type: "config-type"
-    version: "1.0.0"
-    format: "json"
+    version: "1.0.0" -- config schema version
+    format: "json"   -- format of the agent config file
     schema: "./schemas/config-schema.json"
 ```
 
 **All fields are required.** The action validates each configuration entry and will fail with a clear error message if any required field is missing (version, platform, description, type, format, schema).
-
-**Schema files** are automatically base64-encoded and embedded in the output. Schema paths must be relative to the `.fleetControl` directory and cannot use directory traversal (`..`) for security.
+**Dec 2025 - schema temporarily optional until full functionality is ready
+**Schema paths must be relative to the `.fleetControl` directory and cannot use directory traversal (`..`) for security.
 
 ## Building
 

internal/config/definitions.go

@@ -36,8 +36,13 @@ func ReadConfigurationDefinitions(workspacePath string) ([]models.ConfigurationD
 		return nil, fmt.Errorf("configurationDefinitions cannot be empty")
 	}
 
-	// Load and encode schema files (schema is required by validation)
+	// Load and encode schema files (schema is optional for now but will be required in the future)
 	for i := range configFile.Configs {
+		// Skip if no schema path is provided
+		if configFile.Configs[i].Schema == "" {
+			continue
+		}
+
 		// @todo at some point, we may want to do this concurrently if there are any agents with a large number of files
 		encoded, err := loadAndEncodeSchema(workspacePath, configFile.Configs[i].Schema)
 		if err != nil {

internal/config/definitions_test.go

@@ -256,7 +256,7 @@ func TestReadConfigurationDefinitions_ValidationIntegration(t *testing.T) {
 	err := os.MkdirAll(configDir, 0755)
 	require.NoError(t, err)
 
-	// Test one example to verify validation works end-to-end
+	// Test that schema is optional (will be required in the future)
 	configFile := filepath.Join(configDir, "configurationDefinitions.yml")
 	yamlContent := `configurationDefinitions:
   - version: 1.2.3
@@ -269,9 +269,9 @@ func TestReadConfigurationDefinitions_ValidationIntegration(t *testing.T) {
 	require.NoError(t, err)
 
 	configs, err := ReadConfigurationDefinitions(tmpDir)
-	assert.Error(t, err)
-	assert.Nil(t, configs)
-	assert.Contains(t, err.Error(), "schema is required")
+	require.NoError(t, err)
+	assert.Len(t, configs, 1)
+	assert.Equal(t, "", configs[0].Schema) // Schema is empty when not provided
 }
 
 func TestReadConfigurationDefinitions_EmptyArray(t *testing.T) {

internal/models/models.go

@@ -40,6 +40,7 @@ func (c *ConfigurationDefinition) UnmarshalYAML(node *yaml.Node) error {
 	}
 
 	// Validate all required fields
+	// Note: schema is currently optional but will be required in the future
 	for _, check := range []struct {
 		value string
 		field string
@@ -49,7 +50,6 @@ func (c *ConfigurationDefinition) UnmarshalYAML(node *yaml.Node) error {
 		{raw.Description, "description"},
 		{raw.Type, "type"},
 		{raw.Format, "format"},
-		{raw.Schema, "schema"},
 	} {
 		if err := requireField(check.value, check.field, context); err != nil {
 			return err

internal/models/models_test.go

@@ -91,17 +91,6 @@ schema: ./schema.json
 `,
 			expectedError: "format is required",
 		},
-		{
-			name: "missing schema",
-			yamlData: `
-version: 1.0.0
-platform: kubernetes
-description: A test configuration
-type: test-type
-format: json
-`,
-			expectedError: "schema is required",
-		},
 	}
 
 	for _, tt := range tests {
@@ -130,6 +119,27 @@ schema: ./schema.json
 	assert.Contains(t, err.Error(), "platform is required for config with type 'mytype' and version '1.0.0'")
 }
 
+func TestConfigurationDefinition_UnmarshalYAML_OptionalSchema(t *testing.T) {
+	// Schema is optional (for now, but will be required in the future)
+	yamlData := `
+version: 1.0.0
+platform: kubernetes
+description: A test configuration
+type: test-type
+format: json
+`
+	var config ConfigurationDefinition
+	err := yaml.Unmarshal([]byte(yamlData), &config)
+
+	require.NoError(t, err)
+	assert.Equal(t, "1.0.0", config.Version)
+	assert.Equal(t, "kubernetes", config.Platform)
+	assert.Equal(t, "A test configuration", config.Description)
+	assert.Equal(t, "test-type", config.Type)
+	assert.Equal(t, "json", config.Format)
+	assert.Equal(t, "", config.Schema) // Schema is empty when not provided
+}
+
 func TestRequireField_ValidValue(t *testing.T) {
 	err := requireField("some-value", "fieldName", "")
 	assert.NoError(t, err)