https://github.com/labd/terraform-provider-storyblok
Terraform provider to manage Storyblok
https://github.com/labd/terraform-provider-storyblok
storyblok terraform terraform-provider
Last synced: 6 months ago
JSON representation
Terraform provider to manage Storyblok
- Host: GitHub
- URL: https://github.com/labd/terraform-provider-storyblok
- Owner: labd
- License: mpl-2.0
- Created: 2023-05-26T06:14:19.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-07T14:51:54.000Z (7 months ago)
- Last Synced: 2025-03-28T22:51:10.520Z (6 months ago)
- Topics: storyblok, terraform, terraform-provider
- Language: Go
- Homepage: https://registry.terraform.io/providers/labd/storyblok/latest/docs
- Size: 281 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Storyblok Terraform Provider
[](https://github.com/labd/terraform-provider-storyblok/actions?query=workflow%3A%22Run+Tests%22)
[](https://codecov.io/gh/LabD/terraform-provider-storyblok)
[](https://goreportcard.com/report/github.com/labd/terraform-provider-storyblok)
The Terraform Storyblok provider allows you to configure your
[storyblok](https://storyblok.com/) space with infrastructure-as-code
principles.
# Commercial support
Need support implementing this terraform module in your organization? We are
able to offer support. Please contact us at opensource@labdigital.nl
# Quick start
[Read our documentation](https://registry.terraform.io/providers/labd/storyblok/latest/docs)
and check out the [examples](https://registry.terraform.io/providers/labd/storyblok/latest/docs/guides/examples).
## Usage
The provider is distributed via the Terraform registry. To use it you need to configure
the [`required_provider`](https://www.terraform.io/language/providers/requirements#requiring-providers) block. For example:
```hcl
terraform {
required_providers {
storyblok = {
source = "labd/storyblok"
# It's recommended to pin the version, e.g.:
# version = "~> 0.0.1"
}
}
}
```
# Binaries
Packages of the releases are available at
https://github.com/labd/terraform-provider-storyblok/releases See the
[terraform documentation](https://www.terraform.io/docs/configuration/providers.html#third-party-plugins)
for more information about installing third-party providers.
# Contributing
## Building the provider
Clone the repository and run the following command:
```sh
$ task build-local
```
## Debugging / Troubleshooting
There are two environment settings for troubleshooting:
- `TF_LOG=INFO` enables debug output for Terraform.
Note this generates a lot of output!
## Releasing
Install "changie"
```
brew tap miniscruff/changie https://github.com/miniscruff/changie
brew install changie
```
Add unreleased change files by running for each change (add/fix/remove/etc.)
```
changie new
```
Commit this and a new PR will be created.
Once that's merged and its Github action is complete, a new release will be live.
## Testing
### Running unit tests
```sh
$ task test
```
### Running acceptance tests
```sh
$ task testacc
```
Note that acceptance tests by default run based on pre-recorded results. The test stubs can be found in [internal/assets]
(./internal/assets). A good habit is to create a separate stub file per test case, as otherwise there might be conflicts
when multiple tests are run in parallel.
When adding or updating tests locally you can set `RECORD=true` to re-record results. This will clear all previous results
and create a new snapshot of the API interaction.
## Authors
This project is developed by [Lab Digital](https://www.labdigital.nl). We
welcome additional contributors. Please see our
[GitHub repository](https://github.com/labd/terraform-provider-storyblok)
for more information.