Export & document parsing logic #20
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
Update `parse.go` to intentionally export parsing logic in order to allow re-use of the logic for parsing GitHub Actions workflow and manifest files. Even if incomplete, it may be re-usable, plus I'm willing to expand the structs to allow more use cases (it may come in handy for this project in the future). As exported funcs (and structs) there have been given documentation for completeness. The rest of the codebase is kept unexported. While the parsing logic is unlikely to see a breaking change (with the struct renames), the rest of the codebase is, at this point in time, still unstable and likely to have API changes. Signed-off-by: Eric Cornelissen <ericornelissen@gmail.com>
ericcornelissen
force-pushed
the
intentional-exports
branch
from
95cc9ae
to
f105110
Compare
ericcornelissen
added
documentation
Closed
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.
Summary
Update
parse.goto intentionally export parsing logic in order to allow re-use of the logic for parsing GitHub Actions workflow and manifest files. Even if incomplete, it may be re-usable, plus I'm willing to expand the structs to allow more use cases (it may come in handy for this project in the future). As exported funcs (and structs), these have been given documentation for completeness.