Skip to content

Commit 50c5558

Browse files
authored
Update automated testing instructions (#610)
1 parent 47fa8b6 commit 50c5558

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

content/docs/community/automated-testing.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ description: 'Our automated testing strategy and resources'
55

66
## Terraform Testing
77

8-
All of our Terraform modules have automated tests. We have two sets of checks:
8+
All of our Terraform modules have automated tests. We have two sets of checks:
99

10-
- The first set of checks is executed through the feature-branch workflow, which can be found [here](https://github.com/cloudposse/github-actions-workflows-terraform-module/blob/main/.github/workflows/feature-branch.yml)
10+
- The first set of checks is executed through the feature-branch workflow, which can be found [here](https://github.com/cloudposse/github-actions-workflows-terraform-module/blob/main/.github/workflows/feature-branch.yml)
1111
This workflow generates some documentation and performs basic sanity checks, including linting and formatting. These checks are lightweight and can be executed without requiring any special permissions. Consequently, they *are automatically run* on every commit.
1212
Before committing and pushing your changes, you can and should run this set of checks locally by executing the following command on your host
1313
```
@@ -58,9 +58,8 @@ To initialize one of our modules with chatops, run the following commands:
5858
1. `git clone` the terraform module repository
5959
1. `cd $repo` to enter the repository directory
6060
1. `make init` to initialize the build-harness
61-
1. `make github/init` to write all the scaffolding
6261
1. `git add *` to add the changes
63-
1. Add the build badge to the `README.yaml` under the `badges` section.
62+
1. Add the build badge to the `README.yaml` under the `badges` section.
6463
1. `make readme` to rebuild the `README.md` (remember, never edit the `README.md` manually since it's generated from the `README.yaml`)
65-
1. Open up a Pull Request with the changes. Here is a [good example](https://github.com/cloudposse/terraform-github-repository-webhooks/pull/17).
64+
1. Open up a Pull Request with the changes. Here is a [good example](https://github.com/cloudposse/atmos/pull/555).
6665
1. Request a Code Review in the [`#pr-reviews`](https://slack.cloudposse.com) Slack channel (and *big* thanks for your contribution!)

0 commit comments

Comments
 (0)