Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[chore] Improve CONTRIBUTING docs #37

Merged
merged 1 commit into from
Nov 8, 2024
Merged

[chore] Improve CONTRIBUTING docs #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ If acceptance tests fail and leave some undeleted resources on the Retool instan
make test-acc-sweep
```

If you want to see more detailed Terraform logs, add `TF_LOG=info` to your command.

## Recording and replaying HTTP requests for acceptance tests
It's hard to run acceptance tests on CI hitting a live Retool instance. Instead, we have a way to record and store HTTP responses during acceptance test run, then use canned responses to avoid hitting Retool instance.
Recorded responses are stored in `test/data/recordings/<test name>.yaml` files.
Expand All @@ -49,8 +51,18 @@ To run acceptance test using pre-recorded responses, do
FILTER=TestAccFoo make test-acc-replay
```


See `internal/acctest` for implementation details. The implementation was mostly copied from Auth0's Terraform provider: https://github.com/auth0/terraform-provider-auth0/tree/main/internal/acctest
See `internal/acctest` for implementation details. The implementation was mostly copied from Auth0's Terraform provider: https://github.com/auth0/terraform-provider-auth0/tree/main/internal/acctest .
Note that you may run into rate-limiting when recording new tests. See https://registry.terraform.io/providers/tryretool/retool/latest/docs#rate-limiting for more details on how to increase the limits or disable rate limiting completely on your Retool instance.

# Documentation
Run `go generate` in the root of this repository to generate provider docs. See https://developer.hashicorp.com/terraform/tutorials/providers-plugin-framework/providers-plugin-framework-documentation-generation for more details on how to add new examples.

# Publishing new version to Terraform Repository
Go to https://github.com/tryretool/terraform-provider-retool/releases, click "Draft a new release". Create new tag that follows `v<major version>.<minor version>.<patch version>` format. Most of the fixes should only increment the patch version.
Minor version increments should be tied to Retool on-prem stable releases, since they are likely to rely on new API functionality not available in the previous versions. Major version increment should be reserved for major backward-incompatible changes.
Fill out release description and publish it. That'll kick off Github workflow defined [here](https://github.com/tryretool/terraform-provider-retool/blob/d8832910a0cb3cc719387b07caa788d573f6a24c/.github/workflows/release.yaml).
New version should show up on Terraform Repository in 10-15 minutes.

# Update Retool CLI
Retool CLI has a `terraform` command that generates Terraform configuration from existing Retool org: https://github.com/tryretool/retool-cli/blob/master/src/commands/terraform.ts.
If you added a new resource or updated an existing one, you should update Retool CLI as well, so that your changes are reflected in auto-generated configuration.