This is a Terraform provider for Telnyx. It is currently in alpha status and not recommended for production use.
The provider documentation can be found on the registry.
First, you need a couple global dependencies installed, see their documentation for details:
- direnv
- asdf
- Be sure to use the official
gitinstallation method or you may have issues with pre-commit hooks finding~/.asdf/bin
- Be sure to use the official
Note that these tools require a UNIX-style shell, such as bash or zsh. If you are on Windows, you can use WSL or Git Bash. If you are using Pycharm, you can configure the built-in terminal to use Git Bash.
Clone the repo and run direnv allow. This will take a while on the first time to install the remaining dependencies.
You will need to set TELNYX_API_KEY in the .env file to run tests.
To run all tests, run just test. If you add a new resource, be sure to add it
to the tests in provider_test.go.
This project uses conventional commits to power semantic release. This means that when you commit, you should use the following format:
<type>[optional scope]: <description>
For example, feat: Add new feature or fix: Fix bug.
When creating a PR, please name the PR in this way as well so that the squashed commit from the PR will have a conventional commit message. There is a PR check that enforces this.
This project uses Husky and Lint-staged to run pre-commit hooks. This means that when you commit, it will format the files you edited, and also check that your commit message is a conventional commit.
If you are not able to commit, it is likely because your commit message is not in the conventional commit format.
This project uses just to automate various
project activities. Any new project commands should be added to the justfile.
There are commands such as just test and just format-go, see
the justfile for more details.
This project is authored by Patient Engagement Technologies.