Add yaml struct tags for serialization to yaml

[amisevsk]

edit: I found sigs.k8s.io/yaml which is used in this project for serialization/deserialization. This makes this functionality less important, but I'll leave it open in case there's any discussion to be had. Feel free to close issue if it's not applicable.

---

Apologies if this has been discussed before; I remember an issue in the past around this topic but can no longer find it.

Is your feature request related to a problem? Please describe.

Currently, go structs defined in pkg/apis define json tags for all fields to control serialization. However, go-yaml does not read these tags and instead depends on a similarly-structured yaml tag. The defaults for go-yaml are different (and quite bad) which makes serializing/deserializing instances of api structs difficult:

func main() {
	events := v1alpha2.Events{}
	events.PreStart = []string{"Command1", "Command2"}
	yaml, _ := yaml.Marshal(events) // using gopkg.in/yaml.v2
	json, _ := json.MarshalIndent(events, "", "  ")
	fmt.Println("yaml:\n", string(yaml))
	fmt.Println("json:\n", string(json))
}

will output:

yaml:
 workspaceevents:
  prestart:
  - Command1
  - Command2
  poststart: []
  prestop: []
  poststop: []

json:
 {
  "preStart": [
    "Command1",
    "Command2"
  ]
}

Describe the solution you'd like

Define matching yaml struct tags on go structs.

Describe alternatives you've considered

The issue can be worked around by using a package like https://github.com/ghodss/yaml/ but it appears to be unmaintained.

Additional context

I had to work around this issue in PR devfile/devworkspace-operator#188

[github-actions]

This issue is stale because it has been open for 90 days with no activity. Remove stale label or comment or this will be closed in 60 days.