docs: add guide for CI/CD template testing #15528
Merged
Conversation
This file contains hidden or 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
Introduce a new tutorial outlining the process for testing and publishing Coder templates within a CI/CD pipeline using GitHub Actions. This guide includes prerequisites, a comprehensive workflow example, and detailed steps for template validation and deployment.
Add a new entry in the documentation's manifest for a tutorial on testing and publishing Coder templates in a CI/CD pipeline.
bpmct
reviewed
Nov 15, 2024
docs/tutorials/testing-templates.md
Outdated
Comment on lines
96
to
98
| - name: Create a test workspace | ||
| run: | | ||
| coder create -t $TEMPLATE_NAME --template-version ${{ steps.name.outputs.version_name }} --yes |
There was a problem hiding this comment.
Can we also show how to test if specific conditions work inside the template (e.g. make build) or something? Like how to run example commands and ensure they run properly? The coder exp scaletest command may be useful for this.
There was a problem hiding this comment.
coder ssh <workspace> does not let us run the command, and coder exp scale test doesn't let you use a template not set as active.
Another approach could be to use coder config-ssh along with ssh coder.<workspace-name> -- <command to run>.
Add SSH configuration and example commands to test the workspace creation using the new template version. This ensures the template functions as expected before promotion.
|
@jatcod3r Can you be the approver for this PR? |
EdwardAngert
requested changes
Nov 18, 2024
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>
bpmct
reviewed
Nov 19, 2024
jatcod3r
reviewed
Nov 19, 2024
Clarified CLI installation instructions for pushing template versions and linked to the GitHub Actions setup-coder for automation. Removed redundant setup-action note and added details on creating a headless user for CI workflows.
b6d559a to
fa904b2
Compare
jatcod3r
approved these changes
Nov 20, 2024
jatcod3r
reviewed
Nov 20, 2024
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.
Introduce a new tutorial outlining the process for testing and publishing
Coder templates within a CI/CD pipeline using GitHub Actions. This guide
includes prerequisites, a comprehensive workflow example, and detailed
steps for template validation and deployment.
Closes #9899