Update Helm Values Tutorial to use testscript #393
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
Deploying holos with
|
| Latest commit: |
b28c110
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://459d5837.holos.pages.dev |
| Branch Preview URL: | https://gl-update-helm-docs.holos.pages.dev |
glarizza
changed the title
glarizza
changed the title
glarizza
force-pushed
the
gl/update-helm-docs
branch
from
7147b30 to
ae2f11e
Compare
jeffmccune
reviewed
Jan 9, 2025
jeffmccune
reviewed
Jan 9, 2025
jeffmccune
approved these changes
Jan 9, 2025
glarizza
force-pushed
the
gl/update-helm-docs
branch
from
ae2f11e to
f5bf4c1
Compare
We use this module within our markdown tutorials (like the Helm Values tutorial) to load in files generated by testscript.
PROBLEM: The Helm Values tutorial contains a fair bit of code/scripts, and we need a way to test the steps we recommend to make sure nothing breaks or slips out of date. SOLUTION: * Use `testscript` as a way to automate the execution of the steps in the doc and verify that none of the steps produce errors. * Update the MDX file to directly reference the files embedded into the testscript. OUTCOME: * We have an automated way to perform the steps in the Helm Values document. * We have unit tests that will fail should any of the commands being executed in the doc fail. * The doc's MDX file directly references the files within the testscript, so we only need to modify the MDX file to update wording.
glarizza
force-pushed
the
gl/update-helm-docs
branch
from
f5bf4c1 to
b28c110
Compare
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 PR updates the Helm Values tutorial to use the testscript workflow Jeff outlined in #392. Right now all the code within codeblocks has been moved into testscript so that files are generated, and the MDX file has been updated to import and reference those files. That all works well at the moment.
What's left:
holos render platform.update.shfor updates.examplesdirectory (see docs: Add kargo add-on promoter topic #392).