Aug 25, 2025 · Aug 25, 2025 · Aug 25, 2025 · Aug 25, 2025 · Aug 25, 2025 · Aug 25, 2025
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
        run: bun install
      - name: Run TypeScript tests
        run: bun test
      - name: Run Terraform tests
        run: ./scripts/terraform_test_all.sh
      - name: Run Terraform Validate
        run: bun terraform-validate
  validate-style:
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
   - Accurate description and usage examples
   - Correct icon path (usually `../../../../.icons/your-icon.svg`)
   - Proper tags that describe your module
 3. **Create at least one `.tftest.hcl`** to test your module with `terraform test`
 3. **Create tests for your module:**
   - **New modules**: Create `*.tftest.hcl` files and test with `terraform test`
   - **TypeScript tests**: Create `main.test.ts` files if your module runs scripts or has business logic that Terraform tests can't cover
   - **Both approaches** are supported
 4. **Add any scripts** or additional files your module needs

 ### 4. Test and Submit

 ```bash
 # Test your module (from the module directory)
 # Test your module
 cd registry/[namespace]/modules/[module-name]

 # Required: Test Terraform functionality
 terraform init -upgrade
 terraform test -verbose

 #Or run all tests in the repo
 ./scripts/terraform_test_all.sh
 #Optional: Test TypeScript files if you have main.test.ts
 bun test main.test.ts

 # Format code
 bun run fmt
 terraform init -upgrade
 terraform test -verbose

 #Test all modules
 ./scripts/terraform_test_all.sh
 #Optional: If you have TypeScript tests
 bun test main.test.ts
 ```

 ### 3. Maintain Backward Compatibility
 ### Every Module Must Have

 - `main.tf` - Terraform code
 - One or more `.tftest.hcl` files - Working tests with `terraform test`
 - **Tests**:
  - `*.tftest.hcl` files with `terraform test` (to test terraform specific logic)
  - `main.test.ts` file with `bun test` (to test business logic, i.e., `coder_script` to install a package.)
 - `README.md` - Documentation with frontmatter

 ### Every Template Must Have
 2. **No tests** or broken tests
 3. **Hardcoded values** instead of variables
 4. **Breaking changes** without defaults
 5. **Not running** formatting (`bun run fmt`) and tests (`terraform test`) before submitting
 5. **Not running** formatting (`bun run fmt`) and tests (`terraform test`, and `bun test main.test.ts` if applicable) before submitting

 Happy contributing! 🚀
Original file line number	Diff line number	Diff line change
Expand Up		@@ -28,6 +28,8 @@ jobs:
		run: bun install
		- name: Run TypeScript tests
		run: bun test
		- name: Run Terraform tests
		run: ./scripts/terraform_test_all.sh
		- name: Run Terraform Validate
		run: bun terraform-validate
		validate-style:
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -124,18 +124,24 @@ This script generates:
		- Accurate description and usage examples
		- Correct icon path (usually `../../../../.icons/your-icon.svg`)
		- Proper tags that describe your module
		3. Create at least one `.tftest.hcl` to test your module with `terraform test`
		3. Create tests for your module:
		- New modules: Create `*.tftest.hcl` files and test with `terraform test`
		- TypeScript tests: Create `main.test.ts` files if your module runs scripts or has business logic that Terraform tests can't cover
		- Both approaches are supported
matifali marked this conversation as resolved. OutdatedShow resolvedHide resolved
		4. Add any scripts or additional files your module needs

		### 4. Test and Submit

		```bash
		# Test your module (from the module directory)
		# Test your module
		cd registry/[namespace]/modules/[module-name]

		# Required: Test Terraform functionality
		terraform init -upgrade
		terraform test -verbose

		#Or run all tests in the repo
		./scripts/terraform_test_all.sh
		#Optional: Test TypeScript files if you have main.test.ts
		bun test main.test.ts

		# Format code
		bun run fmt
Expand DownExpand Up		@@ -343,8 +349,8 @@ coder templates push test-[template-name] -d .
		terraform init -upgrade
		terraform test -verbose

		#Test all modules
		./scripts/terraform_test_all.sh
		#Optional: If you have TypeScript tests
		bun test main.test.ts
		```

		### 3. Maintain Backward Compatibility
Expand DownExpand Up		@@ -393,7 +399,9 @@ Example: `https://github.com/coder/registry/compare/main...your-branch?template=
		### Every Module Must Have

		- `main.tf` - Terraform code
		- One or more `.tftest.hcl` files - Working tests with `terraform test`
		- Tests:
		- `*.tftest.hcl` files with `terraform test` (to test terraform specific logic)
		- `main.test.ts` file with `bun test` (to test business logic, i.e., `coder_script` to install a package.)
		- `README.md` - Documentation with frontmatter

		### Every Template Must Have
Expand DownExpand Up		@@ -493,6 +501,6 @@ When reporting bugs, include:
		2. No tests or broken tests
		3. Hardcoded values instead of variables
		4. Breaking changes without defaults
		5. Not running formatting (`bun run fmt`) and tests (`terraform test`) before submitting
		5. Not running formatting (`bun run fmt`) and tests (`terraform test`, and `bun test main.test.ts` if applicable) before submitting

		Happy contributing! 🚀