chore: generate Go examples for new modules #1600
Merged
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.
What does this PR do?
This PR adds a new Go template for including a dedicated Go file for Go examples. This examples file will include just an example on how to run the module, with the
RunContainer
function.We have updated the tests, modifying the docs template to embed the code snippet to run a container from the examples, instead of from the test code.
Why is it important?
It will open the gate to add executable code snippets as Go examples:
Related issues
Follow-ups
Visit all modules and example modules, adding an
examples_test.go
file, and finally linking the code snippets in the docs to the new testable Examples code blocks