Skip to content

Commit 7354f0b

Browse files
committed
improve README
1 parent 5bab28d commit 7354f0b

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Overview:
1212
* `project-one` is a minimal Terraform 0.13.7 project that creates `foo.txt` and
1313
`bar.txt` files and uses `s3://tfmigrate-demo/project-one/terraform.tfstate` as
1414
its remote state backend.
15-
* `project-two` is a minimal Terraform 1.4.6 project that a `baz.txt` file and uses
16-
`bar.txt` files and uses `s3://tfmigrate-demo/project-two/terraform.tfstate` as
17-
its remote state backend.
15+
* `project-two` is a minimal Terraform 1.4.6 project that creates a `baz.txt` file
16+
and uses `bar.txt` file and uses `s3://tfmigrate-demo/project-two/terraform.tfstate`
17+
as its remote state backend.
1818
* `project-one` and `project-two` each feature a `.terraform-version` file. This
1919
ensures [tfenv](https://github.com/tfutils/tfenv) selects the proper Terraform
2020
for use in each project.
@@ -26,6 +26,8 @@ See [PR 2](https://github.com/mdb/tfmigrate-demo/pull/2) for an example GitHub
2626
Actions workflow that fails its `tfmigrate plan` step. See [PR 3](https://github.com/mdb/tfmigrate-demo/pull/3) for an example
2727
GitHub Actions workflow that successfully performs a `tfmigrate apply`.
2828

29+
See `.github/workflows/pr.yaml` for the GitHub Actions workflow configuration.
30+
2931
## More detailed problem statement
3032

3133
How can we codify and automate the migration of a Terraform-managed
@@ -39,14 +41,16 @@ with [tfenv](https://github.com/tfutils/tfenv).
3941

4042
## See the demo in GitHub Actions
4143

42-
The workflow described in "Try the demo for yourself" (below) is automated and demo'd in [GitHub Actions](https://github.com/mdb/tfmigrate-demo/actions).
44+
The workflow described in "Try the demo for yourself" (below) is automated and demoed in [GitHub Actions](https://github.com/mdb/tfmigrate-demo/actions).
4345

4446
[PR 2](https://github.com/mdb/tfmigrate-demo/pull/2) triggers an example GitHub
4547
Actions workflow that fails its `tfmigrate plan` step: https://github.com/mdb/tfmigrate-demo/actions/runs/5754942633
4648

4749
[PR 3](https://github.com/mdb/tfmigrate-demo/pull/3) triggers an example GitHub
4850
Actions workflow that successfully performs a `tfmigrate apply` step: https://github.com/mdb/tfmigrate-demo/actions/runs/5754946044
4951

52+
See `.github/workflows/pr.yaml` for the GitHub Actions workflow configuration.
53+
5054
## Try the demo yourself locally
5155

5256
### Install dependencies
@@ -76,9 +80,6 @@ Create a `localstack` `tfmigrate-demo` S3 bucket. This will be used to host
7680
make bootstrap
7781
```
7882

79-
NOTE: This may not actually work; I've only been able to use a real AWS S3
80-
bucket.
81-
8283
### `terraform apply` `project-one`
8384

8485
Initially, `apply`-ing `project-one` results in the creation of 2 files in the

0 commit comments

Comments
 (0)