You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
29 lines
725 B
Markdown
29 lines
725 B
Markdown
# Contributing
|
|
|
|
To create a new module, clone this repository and run:
|
|
|
|
```shell
|
|
./new.sh MODULE_NAME
|
|
```
|
|
|
|
## Testing a Module
|
|
|
|
A suite of test-helpers exists to run `terraform apply` on modules with variables, and test script output against containers.
|
|
|
|
Reference existing `*.test.ts` files for implementation.
|
|
|
|
```shell
|
|
# Run tests for a specific module!
|
|
$ bun test -t '<module>'
|
|
```
|
|
|
|
You can test a module locally by updating the source as follows
|
|
|
|
```tf
|
|
module "example" {
|
|
source = "git::https://github.com/<USERNAME>/<REPO>.git//<MODULE-NAME>?ref=<BRANCH-NAME>"
|
|
}
|
|
```
|
|
|
|
> **Note:** This is the responsibility of the module author to implement tests for their module. and test the module locally before submitting a PR.
|