stackit-dev-tools/terraform-provider-stackitprivatepreview
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix(docs): store IDs of resource after privisioning in contribution guide (#1028)

Browse source 
also adjust the contribution guide to show the new multi-region implementation

relates to STACKITTPR-374
This commit is contained in:
Ruben Hönle 2025-10-15 14:47:16 +02:00 • committed by GitHub
parent 4103c33fd2
commit 2a077d17d8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 109 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTION.md
View file

@ -53,7 +53,7 @@ Let's suppose you want to want to implement a new resource `bar` of service `foo
}
```
Please remeber to always add unit tests for the helper functions (in this case `mapFields` and `toCreatePayload`), as well implementing/extending the acceptance (end-to-end) tests. Our acceptance tests are implemented using Hashicorp's [terraform-plugin-testing](https://developer.hashicorp.com/terraform/plugin/testing/acceptance-tests) package.
Please remember to always add unit tests for the helper functions (in this case `mapFields` and `toCreatePayload`), as well implementing/extending the acceptance (end-to-end) tests. Our acceptance tests are implemented using Hashicorp's [terraform-plugin-testing](https://developer.hashicorp.com/terraform/plugin/testing/acceptance-tests) package.
Additionally, remember to run `make generate-docs` after your changes to keep the commands' documentation in `docs/` updated, which is used as a source for the [Terraform Registry documentation page](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs).
@ -61,7 +61,7 @@ Additionally, remember to run `make generate-docs` after your changes to keep th
Below is a typical structure of a STACKIT Terraform provider resource:
https://github.com/stackitcloud/terraform-provider-stackit/blob/1b9225598a007cda8d8bcadf0db1836e96451353/.github/docs/contribution-guide/resource.go#L26-L295
https://github.com/stackitcloud/terraform-provider-stackit/blob/main/.github/docs/contribution-guide/resource.go
If the new resource `bar` is the first resource in the TFP using a STACKIT service `foo`, please refer to [Onboarding a new STACKIT service](./CONTRIBUTION.md/#onboarding-a-new-stackit-service).
@ -86,7 +86,7 @@ If you want to onboard resources of a STACKIT service `foo` that was not yet in
```
4. Create a utils package, for service `foo` it would be `stackit/internal/foo/utils`. Add a `ConfigureClient()` func and use it in your resource and datasource implementations.
https://github.com/stackitcloud/terraform-provider-stackit/blob/1b9225598a007cda8d8bcadf0db1836e96451353/.github/docs/contribution-guide/utils/util.go#L14-L31
https://github.com/stackitcloud/terraform-provider-stackit/blob/main/.github/docs/contribution-guide/utils/util.go
### Local development