Skip to content

Commit c01ec95

Browse files
Apply suggestions from code review
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>
1 parent 5569c9b commit c01ec95

File tree

2 files changed

+12
-19
lines changed

2 files changed

+12
-19
lines changed

docs/manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -710,7 +710,7 @@
710710
"path": "./tutorials/cloning-git-repositories.md"
711711
},
712712
{
713-
"title": "Testing Templates",
713+
"title": "Test Templates Through CI/CD",
714714
"description": "Learn how to test and publish Coder templates in a CI/CD pipeline",
715715
"path": "./tutorials/testing-templates.md"
716716
},

docs/tutorials/testing-templates.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Testing and Publishing Coder Templates in CI/CD
1+
# Test and Publish Coder Templates Through CI/CD
22

33
<div>
44
<a href="https://github.com/matifali" style="text-decoration: none; color: inherit;">
@@ -19,28 +19,21 @@ ensures your templates are validated, tested, and promoted seamlessly.
1919

2020
## Prerequisites
2121

22-
Before proceeding, ensure the following:
23-
24-
- **Coder CLI** is installed and configured in your environment.
25-
- **Terraform CLI** is installed and available in your CI environment.
26-
- Access to your **Coder instance** with the appropriate
27-
[permissions](../admin/users/groups-roles.md#roles).
22+
- Install and configure Coder CLI in your environment.
23+
- Install Terraform CLI in your CI environment.
24+
- Configure [user roles and permissions](../admin/users/groups-roles.md#roles) for your Coder instance.
2825

2926
## Example GitHub Action Workflow
3027

31-
Below is an example workflow for testing and publishing a template using GitHub
32-
Actions. The workflow first validates the Terraform template, pushes the
33-
template to Coder without activating it, tests the template by creating a
34-
workspace, and then promotes the template version to active upon successful
35-
workspace creation.
28+
This example workflow tests and publishes a template using GitHub
29+
Actions.
3630

37-
### Step-by-Step Process
31+
The workflow:
3832

39-
1. **Validate the Terraform template.**
40-
2. **Push the template to Coder without activating it.**
41-
3. **Test the template by creating a workspace.**
42-
4. **Promote the template version to active upon successful workspace
43-
creation.**
33+
1. Validates the Terraform template.
34+
1. Pushes the template to Coder without activating it.
35+
1. Tests the template by creating a workspace.
36+
1. Promotes the template version to active upon successful workspace creation.
4437

4538
### Workflow File
4639

0 commit comments

Comments
 (0)