Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/speakeasy-sdks/terraform-provider-todoist
https://github.com/speakeasy-sdks/terraform-provider-todoist
Last synced: 2 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/speakeasy-sdks/terraform-provider-todoist
- Owner: speakeasy-sdks
- License: mit
- Created: 2024-06-06T11:15:24.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-06-12T18:06:27.000Z (5 months ago)
- Last Synced: 2024-06-13T00:14:13.871Z (5 months ago)
- Language: Go
- Size: 122 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# todoist
To install this provider, copy and paste this code into your Terraform configuration. Then, run `terraform init`.
```hcl
terraform {
required_providers {
todoist = {
source = "speakeasy/todoist"
version = "0.0.1"
}
}
}
provider "todoist" {
# Configuration options
}
```
### Testing the provider locally
Should you want to validate a change locally, the `--debug` flag allows you to execute the provider against a terraform instance locally.
This also allows for debuggers (e.g. delve) to be attached to the provider.
### Example
```sh
go run main.go --debug
# Copy the TF_REATTACH_PROVIDERS env var
# In a new terminal
cd examples/your-example
TF_REATTACH_PROVIDERS=... terraform init
TF_REATTACH_PROVIDERS=... terraform apply
```
## SDK Installation
To install this provider, copy and paste this code into your Terraform configuration. Then, run `terraform init`.
```hcl
terraform {
required_providers {
todoist = {
source = "speakeasy/todoist"
version = "0.1.0"
}
}
}
provider "todoist" {
# Configuration options
}
```
## SDK Example Usage
### Testing the provider locally
Should you want to validate a change locally, the `--debug` flag allows you to execute the provider against a terraform instance locally.
This also allows for debuggers (e.g. delve) to be attached to the provider.
### Example
```sh
go run main.go --debug
# Copy the TF_REATTACH_PROVIDERS env var
# In a new terminal
cd examples/your-example
TF_REATTACH_PROVIDERS=... terraform init
TF_REATTACH_PROVIDERS=... terraform apply
```
## Available Resources and Operations
Terraform allows you to use local provider builds by setting a `dev_overrides` block in a configuration file called `.terraformrc`. This block overrides all other configured installation methods.
Terraform searches for the `.terraformrc` file in your home directory and applies any configuration settings you set.
```
provider_installation {
dev_overrides {
"registry.terraform.io/speakeasy/todoist" = ""
}
# For all other providers, install them directly from their origin provider
# registries as normal. If you omit this, Terraform will _only_ use
# the dev_overrides block, and so no other providers will be available.
direct {}
}
```
Your `` may vary depending on how your Go environment variables are configured. Execute `go env GOBIN` to set it, then set the `` to the value returned. If nothing is returned, set it to the default location, `$HOME/go/bin`.
Note: To use the dev_overrides, please ensure you run `go build` in this folder. You must have a binary available for terraform to find.
### Contributions
While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)