You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
9
9
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)
11
11
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.
12
12
Before committing and pushing your changes, you can and should run this set of checks locally by executing the following command on your host
13
13
```
@@ -58,9 +58,8 @@ To initialize one of our modules with chatops, run the following commands:
58
58
1.`git clone` the terraform module repository
59
59
1.`cd $repo` to enter the repository directory
60
60
1.`make init` to initialize the build-harness
61
-
1.`make github/init` to write all the scaffolding
62
61
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.
64
63
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).
66
65
1. Request a Code Review in the [`#pr-reviews`](https://slack.cloudposse.com) Slack channel (and *big* thanks for your contribution!)
0 commit comments