Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

chore: update CONTRIBUTION docs to explain both tests, and update CI for both tests#384

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

Open
DevelopmentCats wants to merge14 commits intomain
base:main
Choose a base branch
Loading
fromcat/contrib-docs-testing
Open
Show file tree
Hide file tree
Changes fromall commits
Commits
Show all changes
14 commits
Select commitHold shift + click to select a range
82d06f9
docs: update contribution guidelines for both module testing procedures
DevelopmentCatsAug 25, 2025
7469a6e
ci: add Terraform tests to CI workflow
DevelopmentCatsAug 25, 2025
a7bad95
chore: bun run fmt
DevelopmentCatsAug 25, 2025
37cde45
chore: clarify module requirements
DevelopmentCatsAug 25, 2025
2a78dc8
chore: add wildcard to tftest.hcl
DevelopmentCatsAug 25, 2025
6a98f83
docs(contributing): clarify testing procedures and requirements
DevelopmentCatsAug 25, 2025
7cd4969
Apply suggestion from @matifali
matifaliAug 26, 2025
7f94259
Merge branch 'main' into cat/contrib-docs-testing
matifaliAug 26, 2025
af28c4f
Merge branch 'main' into cat/contrib-docs-testing
matifaliAug 29, 2025
d7e2892
Merge branch 'main' into cat/contrib-docs-testing
DevelopmentCatsSep 10, 2025
276c61a
Merge branch 'main' into cat/contrib-docs-testing
DevelopmentCatsOct 1, 2025
3920709
fix(examples): standardize module naming from MODULE_NAME to module_n…
DevelopmentCatsOct 1, 2025
7cefd58
chore: resolve index issue with claude-code tf test
DevelopmentCatsOct 1, 2025
32f2e05
Merge branch 'main' into cat/contrib-docs-testing
DevelopmentCatsOct 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions.github/workflows/ci.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff 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
23 changes: 15 additions & 8 deletionsCONTRIBUTING.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -124,18 +124,23 @@ 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:**
- **Terraform tests**: Create a `*.tftest.hcl` file and test with `terraform test`
- **TypeScript tests**: Create `main.test.ts` file if your module runs scripts or has business logic that Terraform tests can't cover
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 +348,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 +398,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 +500,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! 🚀
4 changes: 2 additions & 2 deletionsexamples/modules/MODULE_NAME.tftest.hcl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ run "app_url_uses_port" {
}

assert {
condition = resource.coder_app.MODULE_NAME.url == "http://localhost:19999"
error_message = "ExpectedMODULE_NAME app URL to include configured port"
condition = resource.coder_app.module_name.url == "http://localhost:19999"
error_message = "Expectedmodule-name app URL to include configured port"
}
}
24 changes: 12 additions & 12 deletionsexamples/modules/main.tf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,13 +35,13 @@ variable "agent_id" {

variable "log_path" {
type = string
description = "The path to logMODULE_NAME to."
default = "/tmp/MODULE_NAME.log"
description = "The path to logmodule-name to."
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I don't think this is a huge deal, but I could see it being a slight source of confusion: is there a reason why we usemodule-name for the descriptions, but still usemodule_name for the resource names?

default = "/tmp/module-name.log"
}

variable "port" {
type = number
description = "The port to runMODULE_NAME on."
description = "The port to runmodule-name on."
default = 19999
}

Expand All@@ -59,9 +59,9 @@ variable "order" {
# Add other variables here


resource "coder_script" "MODULE_NAME" {
resource "coder_script" "module_name" {
agent_id = var.agent_id
display_name = "MODULE_NAME"
display_name = "Module Name"
icon = local.icon_url
script = templatefile("${path.module}/run.sh", {
LOG_PATH : var.log_path,
Expand All@@ -70,10 +70,10 @@ resource "coder_script" "MODULE_NAME" {
run_on_stop = false
}

resource "coder_app" "MODULE_NAME" {
resource "coder_app" "module_name" {
agent_id = var.agent_id
slug = "MODULE_NAME"
display_name = "MODULE_NAME"
slug = "module-name"
display_name = "Module Name"
url = "http://localhost:${var.port}"
icon = local.icon_url
subdomain = false
Expand All@@ -88,10 +88,10 @@ resource "coder_app" "MODULE_NAME" {
}
}

data "coder_parameter" "MODULE_NAME" {
type = "list(string)"
name = "MODULE_NAME"
display_name = "MODULE_NAME"
data "coder_parameter" "module_name" {
type = "string"
name = "module_name"
display_name = "Module Name"
icon = local.icon_url
mutable = var.mutable
default = local.options["Option 1"]["value"]
Expand Down
[8]ページ先頭
©2009-2025 Movatter.jp