Skip to content

Files

Latest commit

 

History

History
63 lines (41 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

63 lines (41 loc) · 1.33 KB

Typical development workflow

Fork the repo, work on an issue

Acceptance tests

make docker-testacc

Run a single test with terraform debug enabled:

env TF_LOG=DEBUG make docker-testacc TESTARGS='-run ^TestAccResourceDataStreamLifecycle$$'

A way to forward debug logs to a file:

env TF_ACC_LOG_PATH=/tmp/tf.log TF_ACC_LOG=DEBUG TF_LOG=DEBUG make docker-testacc

Update documentation

Update documentation templates in ./templates directory and re-generate docs via:

make docs-generate

Update ./CHANGELOG.md

List of previous commits is a good example of what should be included in the changelog.

Pull request

Format the code before pushing:

make fmt

Check if the linting:

make lint

Create a PR and check acceptance test matrix is green.

Run provider with local terraform

TBD

Releasing

Releasing is implemented in CI pipeline.

To release a new provider version:

  • Create PR which
  • updates Makefile with the new provider VERSION (e.g. VERSION ?= 0.11.13);
  • updates CHANGELOG.md with the list of changes being released. Example.
  • Once the PR merged, the release CI pipeline can be started by pushing a new release tag to main branch.