modules/CONTRIBUTING.md

Contributing

To create a new module, clone this repository and run:

./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.

The testing suite must be able to run docker containers with the --network=host flag, which typically requires running the tests on Linux as this flag does not apply to Docker Desktop for MacOS and Windows. MacOS users can work around this by using something like colima or Orbstack instead of Docker Desktop.

Reference existing *.test.ts files for implementation.

# Run tests for a specific module!
$ bun test -t '<module>'

You can test a module locally by updating the source as follows

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.