feat: config file schema versioning

assets/versions/versions.json

@@ -0,0 +1,4 @@
+{
+  "cliVersion": "v0.5.0",
+  "configFileSchemaVersion": "v1"
+}

src/cli/init.go

@@ -11,12 +11,15 @@ import (
 
 	"github.com/nearform/initium-cli/src/services/k8s"
 	"github.com/nearform/initium-cli/src/services/project"
+	"github.com/nearform/initium-cli/src/services/versions"
 	"github.com/nearform/initium-cli/src/utils/defaults"
 	"github.com/urfave/cli/v2"
 )
 
 const (
 	persistFlag = "persist"
+
+	configFileSchemaVersionFlagName = "schema-version"
 )
 
 func (c icli) InitGithubCMD(cCtx *cli.Context) error {
@@ -83,6 +86,12 @@ func (c icli) InitConfigCMD(ctx *cli.Context) error {
 		config = config + next
 	}
 
+	configFileSchemaVersion, err := versions.LoadConfigFileSchemaVersion(c.Resources)
+	if err != nil {
+		return err
+	}
+	config = fmt.Sprintf("%s: %s\n", configFileSchemaVersionFlagName, configFileSchemaVersion) + config
+
 	if ctx.Bool(persistFlag) {
 		f, err := os.OpenFile(filepath.Join(ctx.String(projectDirectoryFlag), defaults.ConfigFile), os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0644)
 		if err != nil {

src/cli/init_test.go

@@ -14,14 +14,17 @@ import (
 )
 
 func compareConfig(t *testing.T, appName string, registry string, writer io.Writer) {
-	configTemplate := fmt.Sprintf(`app-name: %s
+	currentConfigVersion := "v1"
+	configTemplate := fmt.Sprintf(`schema-version: %s
+app-name: %s
 cluster-endpoint: null
 container-registry: %s
 default-branch: main
 dockerfile-name: null
 registry-user: null
 runtime-version: null
 `,
+		currentConfigVersion,
 		appName,
 		registry,
 	)

src/services/versions/versions.go

@@ -0,0 +1,27 @@
+package versions
+
+import (
+	"encoding/json"
+	"io/fs"
+	"path"
+)
+
+type VersionsFile struct {
+	CliVersion              string `json:"cliVersion"`
+	ConfigFileSchemaVersion string `json:"configFileSchemaVersion"`
+}
+
+func LoadConfigFileSchemaVersion(resources fs.FS) (string, error) {
+	bytes, err := fs.ReadFile(resources, path.Join("assets", "versions", "versions.json"))
+	if err != nil {
+		return "", err
+	}
+
+	var versionsFile VersionsFile
+	err = json.Unmarshal(bytes, &versionsFile)
+	if err != nil {
+		return "", err
+	}
+
+	return versionsFile.ConfigFileSchemaVersion, nil
+}