Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

56 lines (37 loc) · 2.9 KB

Contributing

This is a BETA provider, managed by the Kong team. You're probably looking for terraform-provider-konnect

Local Generation

This provider is generated from openapi.yaml using Speakeasy. To test a new version, use the following steps:

  • Run make generate
  • Run go mod tidy to download all dependencies
  • If you use the KONNECT_TOKEN env var to authenticate, run export KONNECT_TOKEN before running the provider
  • Run go run main.go -debug
  • Take the TF_REATTACH_PROVIDERS variable and run export TF_REATTACH_PROVIDERS=... in your terminal
  • Run terraform apply in the same directory as your manifests

Assuming that your changes are working, raise a PR to platform-api for review then see contributing features

Contributing features

  • Create a new release branch (if needed) named release/x.y.z, where x.y.z is the new version
  • Update the terraform.version key in the gen.yaml file to x.y.z and git add gen.yaml
  • Run ./tools/gen_beta_terraform.sh on the main branch of platform-api to update the openapi.yaml file in this repo
  • Run make generate to generate the provider (see local generation)
  • Test your changes to ensure the provider still works
  • git add openapi.yaml and commit the changes as a single commit
  • git add and commit the provider's .go files, plus the .speakeasy and docs directory
  • Add examples for your new resources to examples/resources, git add them and make a third commit
  • Update CHANGELOG.md with descriptions of fixes and changes and git add for a fourth commit
  • Raise a PR against release/x.y.z for review

Submitting your changes as four commits is not a hard requirement, but it makes it easier to review the PR as four distinct sets of work:

  1. OpenAPI changes
  2. Provider changes
  3. New examples
  4. Changelog

Once the release/x.y.z branch is merged to main, a new release will automatically be created and published to the Terraform registry.

Releasing the provider

This repository is automatically released when the .speakeasy/gen.lock file on main changes.

This usually happens when a release/x.y.z branch (see above) is merged in to main.

Before merging a release branch, update the release branch directly to set a release date in CHANGELOG.md. Once the release is complete, copy the changelog entry in to GitHub releases.

openapi.yaml

The openapi.yaml file in this repository is generated from Kong's platform-api repository (this repository is not OSS). Any changes made directly to openapi.yaml will be lost.

Please raise an issue if you have suggested changes to openapi.yaml.

Automated Testing

The make test target runs some end to end tests against an org that @mheap owns. The tests need some refactoring (system account team IDs need to be dynamic) before anyone else can run them.