Merge branch 'alpha'

.commitlintrc.yaml

@@ -0,0 +1,8 @@
+extends:
+  - "@commitlint/config-conventional"
+
+rules:
+  subject-case: [2, "always", ["sentence-case"]]
+  footer-max-line-length: [0, "always", 100]
+  footer-max-length: [0, "always", 100]
+  header-max-length: [0, "always", 100]

.envrc

@@ -4,3 +4,4 @@ dotenv
 source_env scripts/env/setup-path.sh
 source_env scripts/env/install-just.sh
 . scripts/env/asdf-install.sh
+[ -d "node_modules" ] || pnpm install

.github/workflows/release.yaml

@@ -2,8 +2,10 @@ name: Release
 
 on:
   push:
-    tags:
-      - "v*.*.*"
+    branches:
+      - main
+      - alpha
+      - beta
 
 jobs:
   release:
@@ -37,7 +39,13 @@ jobs:
         working-directory: ./provider/provider
         run: go mod tidy
 
-      - name: Run GoReleaser
-        working-directory: provider
-        run: |
-          curl -sL https://git.io/goreleaser | bash
+      - name: Semantic Release
+        id: semantic-release
+        uses: cycjimmy/semantic-release-action@v3
+
+      - uses: goreleaser/goreleaser-action@v4
+        if: steps.semantic-release.outputs.new_release_published == 'true'
+        with:
+          version: "~> v2"
+          workdir: ./provider
+          args: release

.gitignore

@@ -2,3 +2,4 @@
 **/.env
 **/output.txt
 last-test.log
+node_modules/

.goreleaser.yml

@@ -46,6 +46,8 @@ signs:
       - "${artifact}"
 
 release:
+  github: 
+  prerelease: auto
   extra_files:
     - glob: 'terraform-registry-manifest.json'
       name_template: '{{ .ProjectName }}_{{ .Version }}_manifest.json'

.husky/commit-msg

@@ -0,0 +1,8 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+# Workaround to get lint-staged to work outside of main shell
+# (e.g. Git GUIs)
+ASDF_SHIMS_PATH=$(realpath ~/.asdf/shims)
+ASDF_BIN_PATH=$(realpath ~/.asdf/bin)
+PATH="$ASDF_SHIMS_PATH:$ASDF_BIN_PATH:$PATH" npx --no -- commitlint --edit "$1"

.husky/pre-commit

@@ -0,0 +1,8 @@
+#!/bin/bash
+. "$(dirname "$0")/_/husky.sh"
+
+# Workaround to get lint-staged to work outside of main shell
+# (e.g. Git GUIs)
+ASDF_SHIMS_PATH=$(realpath ~/.asdf/shims)
+ASDF_BIN_PATH=$(realpath ~/.asdf/bin)
+PATH="$ASDF_SHIMS_PATH:$ASDF_BIN_PATH:$PATH" npx lint-staged

.lintstagedrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  "*.{tf,hcl}": "node with-direnv.js just format-hcl",
+  "*.go": "node with-direnv.js just format-go",
+};

.releaserc.yaml

@@ -0,0 +1,14 @@
+branches:
+  - "+([0-9])?(.{+([0-9]),x}).x"
+  - main
+  - name: beta
+    prerelease: true
+  - name: alpha
+    prerelease: true
+
+repositoryUrl: https://github.com/petsinc/terraform-provider-telnyx
+
+plugins:
+  - "@semantic-release/commit-analyzer"
+  - "@semantic-release/release-notes-generator"
+  - "@semantic-release/github"

.tool-versions

@@ -1,4 +1,6 @@
 terraform 1.7.3
+nodejs 18.19.0
+pnpm 8.10.2
 
 # Be sure to keep this in sync with .github/release.yml
 golang 1.22.5

README.md

@@ -0,0 +1,77 @@
+# Telnyx Terraform Provider
+
+This is a Terraform provider for Telnyx. It is currently in alpha status and not recommended
+for production use.
+
+## Documentation
+
+The provider [documentation can be found on the registry](https://registry.terraform.io/providers/petsinc/telnyx/latest/docs).
+
+## Developing
+
+### Initial Setup
+
+#### Direct System Dependencies
+
+First, you need a couple global dependencies installed, see their documentation for details:
+
+- [direnv](https://direnv.net/docs/installation.html)
+- [asdf](https://asdf-vm.com/guide/getting-started.html)
+  - Be sure to use the official `git` installation method or you may have issues with
+    pre-commit hooks finding `~/.asdf/bin`
+
+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.
+
+#### First Steps
+
+Clone the repo and run `direnv allow`. This will take a while on the first time to install the remaining dependencies.
+
+#### ENV Variables
+
+You will need to set `TELNYX_API_KEY` in the `.env` file to run tests.
+
+## Day-to-day Development
+
+### 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`.
+
+### Conventional Commits & Semantic Release
+
+This project uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
+to power [semantic release](https://semantic-release.gitbook.io/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.
+
+### Pre-commit Hooks
+
+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.
+
+### `justfile`
+
+This project uses [`just`](https://github.com/casey/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.
+
+## Author
+
+This project is authored by Patient Engagement Technologies.

justfile

@@ -3,8 +3,27 @@ provider_dir := "provider/provider/internal/provider"
 test:
     #!/usr/bin/env bash
     set -eou pipefail
-
     cd {{provider_dir}}
 
     export TF_ACC_TERRAFORM_PATH=$(asdf which terraform)
-    TF_ACC=true go test 2>&1 | tee -a {{justfile_directory()}}/last-test.log ; ( exit ${PIPESTATUS} )
+    TF_ACC=true go test 2>&1 | tee -a {{justfile_directory()}}/last-test.log ; ( exit ${PIPESTATUS} )
+
+
+format-hcl *FILES='.':
+    #!/usr/bin/env bash
+    # If files is ., then just run at root recursively
+    if [ "{{FILES}}" = "." ]; then
+        terraform fmt -recursive
+        exit 0;
+    fi
+
+    # Specific files, run them one by one
+    for file in {{FILES}}; do
+        if [[ "$file" == *.tf ]]; then
+            terraform fmt "$file"
+        fi
+    done
+
+format-go *FILES=provider_dir:
+    gofmt -w {{FILES}}
+

package.json

@@ -0,0 +1,18 @@
+{
+  "name": "local-dev",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "just": "./scripts/env/bin/just",
+    "prepare": "husky install"
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@commitlint/cli": "^16.2.3",
+    "@commitlint/config-conventional": "^16.2.1",
+    "lint-staged": "^12.4.1",
+    "husky": "^7.0.4"
+  }
+}