Add struct tag to Buildpack.Path field #86
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
Most Go applications use github.com/burntsushi/toml as their toml parsing library. When struct tags are omitted, the library will do case-insensitive deserialization, so a property called "path" will successfully unmarshal into the Path struct field. However, if you marshal a Buildpack instance to toml, the "Path = " field appears regardless of whether it is set or not, and technically violates the buildpack toml spec. This PR adds a struct tag to not only marshal the field to the "path" property in the resultant toml, but also adds the "omitempty" modifier to ignore the field altogether when not set. Signed-off-by: Josh Ghiloni <[email protected]>
|
I don't believe that |
dmikusa
added
semver:patch
|
That sounds good -- I'll add another commit changing that behavior |
Signed-off-by: Josh Ghiloni <[email protected]>
dmikusa
approved these changes
Nov 4, 2021
sambhav
reviewed
Nov 4, 2021
Signed-off-by: Josh Ghiloni <[email protected]>
sambhav
approved these changes
Nov 4, 2021
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.
Most Go applications use
github.com/burntsushi/tomlas their toml parsing library. When struct tags are omitted, the library will do case-insensitive deserialization, so a property calledpathwill successfully unmarshal into thePathstruct field.However, if youmarshal a Buildpack instance to toml, the
Pathfield appears regardless of whether it is set or not, and technically violates the buildpack toml spec. This PR adds a struct tag to not only marshal the field to thepathproperty in the resultant toml, but also adds theomitemptymodifier to ignore the field altogether when not set.This resolves #85
Signed-off-by: Josh Ghiloni [email protected]