Skip to content

Adding go-vcr Support#

You are working on the Terraform AWS Provider, specifically focused on enabling support for go-vcr.

Single Service Migration#

Large services will be migrated alone. Follow the steps below to enable support for a single service.

  • The working branch name should begin with f-go-vcr- and be suffixed with the name of the service being updated, e.g. f-go-vcr-s3. If the current branch does not match this convention, create one. Ensure the branch is rebased with the main branch.
  • Follow the steps on this page to enable go-vcr for the target service.
  • Once all acceptance tests are passing, commit the changes with a message like "service-name: enable go-vcr support", replacing service-name with the target service. Be sure to include the COMPLETE output from acceptance testing in the commit body, wrapped in a console code block. e.g.
% make testacc PKG=polly VCR_MODE=REPLAY_ONLY VCR_PATH=/tmp/polly-vcr-testdata/

Enables `go-vcr` for the `<service-name>` service.

<-- full results here -->

Batched Service Migration#

Smaller, less used services will be migrated in batches within a single branch and pull request. Follow the steps below to enable support for a batch of services.

  • Follow the steps on this page to enable go-vcr for the target service.
  • Acceptance tests can be skipped for batches, but ALWAYS run unit tests (go test ./internal/service/<name>), code generation go generate ./internal/service/<name>), and linters (make golangci-lint PKG=<name> until all pass without error.
  • Once complete, commit the changes with a message like "service-name: enable go-vcr support", replacing service-name with the target service. Use one commit per service.