26 lines (19 loc) · 1.46 KB

Repository Guidance for Codex Agents

This repository contains Terraform code and Go-based tests for deploying and verifying an Azure Kubernetes Service cluster. The following conventions apply when modifying code here.

Scope

These instructions apply to the entire repository.

Formatting

Run terraform fmt -recursive whenever Terraform files (*.tf) are changed.
Run go fmt ./... if Go source files under test/ are modified.

Linting

After initializing Terraform (terraform init), run terraform validate for Terraform code changes.
Always execute terraform plan to ensure the configuration produces a valid plan. Saving the plan output with terraform plan -out=plan.out is recommended.
For Go code, run golangci-lint run or go vet ./... when available.

Testing

Unit tests are located in test/unit. Run go test ./test/unit/....
Integration tests in test/integration require Azure credentials and may incur cost. Run them only when necessary with RUN_INTEGRATION_TESTS=true go test ./test/integration/....
When files under the test/ directory change, execute go test ./... and ensure golangci-lint run and go fmt ./... pass.

Workflow

Code changes (Terraform or Go) require running the format, lint, and test steps above before committing.
For Terraform changes, include terraform plan as part of the workflow to verify the execution plan.
Documentation or comment-only changes may skip tests and linting.