feat: implement yaml functions based on helm implementation

42atomys commented 4 months ago

Description

We continue to backport features, bug fixes, and more from Sprig to Sprout. This time, I'm focusing on the YAML functions part, used by Helm and intended for use by others as well.

Changes

Add fromYaml function to convert yaml string into a go map
Add toYaml function to convert any to a yaml string
Add mustFromYaml function to convert and return error to the template system when occurs
Add mustToYaml function to convert and return error to the template system when occurs

Fixes https://github.com/Masterminds/sprig/issues/358 https://github.com/Masterminds/sprig/pull/360

Checklist

[x] I have read the CONTRIBUTING.md document.
[x] My code follows the code style of this project.
[x] I have added tests to cover my changes.
[x] All new and existing tests passed.
[ ] I have updated the documentation accordingly.
[x] This change requires a change to the documentation on the website.

Additional Information

The documentation for the encoding part of the library will be released soon after this pull request on https://sprout.atom.codes

Initially implemented by @blakepettersson on sprig

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Files	Coverage Δ
encoding_functions.go	`100.0% <100.0%> (ø)`
sprout.go	`100.0% <100.0%> (ø)`

andig commented 3 months ago

Does this PR actually need sigs.k8s.io/yaml or rather gopkg.in/yaml.v3? Seems the dependency tree could be reduced a little but by removing k8s.

go-sprout / sprout