- Notifications
You must be signed in to change notification settings - Fork914
docs: add guide for CI/CD template testing#15528
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Introduce a new tutorial outlining the process for testing and publishingCoder templates within a CI/CD pipeline using GitHub Actions. This guideincludes prerequisites, a comprehensive workflow example, and detailedsteps for template validation and deployment.
Add a new entry in the documentation's manifest for a tutorial on testingand publishing Coder templates in a CI/CD pipeline.
docs/tutorials/testing-templates.md Outdated
- 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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? Thecoder exp scaletest
command may be useful for this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
coder ssh <workspace>
does not let us run the command, andcoder exp scale test
doesn't let you use a template not set as active.
Another approach could be to usecoder config-ssh
along withssh coder.<workspace-name> -- <command to run>
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Would love@jatcod3r's review as this was something we were discussing lately. We could add this to our demo env
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? |
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
🚀
Uh oh!
There was an error while loading.Please reload this page.
Clarified CLI installation instructions for pushing template versionsand linked to the GitHub Actions setup-coder for automation. Removedredundant setup-action note and added details on creating a headlessuser for CI workflows.
b6d559a
tofa904b2
CompareUh oh!
There was an error while loading.Please reload this page.
dcbcf67
intomainUh oh!
There was an error while loading.Please reload this page.
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