add format_version mutation #3
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andrewkroh
reviewed
Nov 4, 2022
ecs-update/ecs-update.go
Outdated
| if formatVersion == "2.0.0" { | ||
| pkg.Manifest.OriginalData.License = "" | ||
| } | ||
| err = WriteDocument(&pkg.Manifest, pkg.Manifest.WriteYAML) |
There was a problem hiding this comment.
I think there are two problems that stem from gopkg.in/yaml not being able to roundtrip content while preserving the format.
- Marshaling the manifest.yml back out results in larger than necessary diffs and possibly loss of comments. I introduced some big hacks (which are probably more complicated than alternative approaches) to edit the YAML content for the other changes that are being made. My hack is not sustainable.
Probably a better approach would be have a consistent YAML formatting applied to the files such that it does not matter if the tool produces a different ordering since we can just sort it again. But the comments being lost is still a problem. Maybeyqcommands could be an option. - My manifest structs do not have all of the possible attributes. So when you marshal the struct back out you lose attributes. This was OK before when I was only reading the attributes that I needed and was editing the original YAML code and yaml.Node. The solution for this is to use structs generated from package-spec.
There was a problem hiding this comment.
I've replaced the logic here with a real YAML AST handler so those issues should no longer be problems.
andrewkroh
approved these changes
Nov 14, 2022
|
Be aware that goccy/go-yaml has some bugs that make it unsafe with invalid YAML. I would review the issues. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds the capacity to bump the format version.
A number of changes were needed, mainly around the YAML codec (yaml.v3 doesn't respect json struct tags).
Please take a look.
For elastic/integrations#4518