Skip to content

Commit 208391a

Browse files
committed
docs: add go-vcr migration guide
1 parent e338dda commit 208391a

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Adding `go-vcr` Support
2+
3+
You are working on the [Terraform AWS Provider](https://github.com/hashicorp/terraform-provider-aws), specifically focused on enabling support for `go-vcr`.
4+
5+
Follow the steps below to enable support for a single service.
6+
7+
- 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.
8+
- Follow the steps on [this page](../go-vcr.md) to enable `go-vcr` for the target service.
9+
- Once all acceptace 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.
10+
11+
```console
12+
% make testacc PKG=polly VCR_MODE=REPLAY_ONLY VCR_PATH=/tmp/polly-vcr-testdata/
13+
14+
<-- full results here -->
15+
```

0 commit comments

Comments
 (0)