|
1 | | -######################################################################################################################## |
2 | | -######################################################################################################################## |
3 | | -######################################################################################################################## |
4 | | -# DELETE ME |
5 | | -# |
6 | | -# This is the README configuration for the Example module itself. |
7 | | -# Delete this (up to and including the line with `---`) and fill in |
8 | | -# the template below the dashes |
9 | | - |
10 | | -# Name of this project |
11 | | -name: terraform-example-module |
12 | | - |
13 | | -# License of this project |
14 | | -license: "APACHE2" |
15 | | - |
16 | | -# Copyrights |
17 | | -copyrights: |
18 | | - - name: "Cloud Posse, LLC" |
19 | | - url: "https://cloudposse.com" |
20 | | - year: "2021" |
21 | | - |
22 | | -# Canonical GitHub repo |
23 | | -github_repo: cloudposse/terraform-example-module |
24 | | - |
25 | | -description: |- |
26 | | - This is an example project to provide all the scaffolding for a typical well-built Cloud Posse |
27 | | - Terraform module for AWS resources. It's a template repository you can |
28 | | - use when creating new repositories. This is not a useful module by itself. |
29 | | -
|
30 | | -quickstart: |- |
31 | | - 1. Use this repo as a template for a new repo. |
32 | | - 2. Check out the new repo and create a `git` branch to work on. |
33 | | - 3. Replace the Terraform code at the root of the repo with the code you want to publish. |
34 | | - 4. Replace the code in `examples/complete` with Terraform code that will make a good automated test. |
35 | | - Please keep `context.tf` and `fixtures.us-east-2.tfvars` in place and change only `name`, leaving |
36 | | - `region`, `namespace`, `environment`, and `stage` as is. Provide outputs that will be useful for testing. |
37 | | - 5. Update `test/src/examples_complete_test.go` to verify the outputs of running `terraform apply` on `examples/complete`. |
38 | | - 6. Run `make github/init` to update the repo with the current Cloud Posse framework files (e.g. `CODEOWNERS`). |
39 | | - 7. Run `make pr/auto-format` to format the Terraform code and generate documentation. |
40 | | - 8. Commit everything to `git` and open your first PR on the new repo. |
41 | | -
|
42 | | -references: |
43 | | - - name: "Cloud Posse Documentation" |
44 | | - url: "https://docs.cloudposse.com" |
45 | | - description: "The Cloud Posse Developer Hub (documentation)" |
46 | | - - name: "Terraform Standard Module Structure" |
47 | | - description: "HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories." |
48 | | - url: "https://www.terraform.io/docs/language/modules/develop/structure.html" |
49 | | - - name: "Terraform Module Requirements" |
50 | | - description: "HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy." |
51 | | - url: "https://www.terraform.io/docs/registry/modules/publish.html#requirements" |
52 | | - - name: "Terraform Version Pinning" |
53 | | - description: "The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration" |
54 | | - url: "https://www.terraform.io/docs/language/settings/index.html#specifying-a-required-terraform-version" |
55 | | - |
56 | | - |
57 | | -# List any related terraform modules that this module may be used with or that this module depends on. |
58 | | - |
59 | | -# List any related terraform modules that this module may be used with or that this module depends on. |
60 | | -related: |
61 | | - - name: "Example App" |
62 | | - url: "https://github.com/cloudposse/example-app" |
63 | | - description: "Example application for CI/CD demonstrations of Codefresh" |
64 | | - |
65 | | - |
66 | | -badges: |
67 | | - - name: Last Updated |
68 | | - image: https://img.shields.io/github/last-commit/cloudposse/terraform-example-module.svg?style=for-the-badge |
69 | | - url: https://github.com/cloudposse/terraform-example-module/commits |
70 | | - - name: Latest Release |
71 | | - image: https://img.shields.io/github/release/cloudposse/terraform-example-module.svg?style=for-the-badge |
72 | | - url: https://github.com/cloudposse/terraform-example-module/releases/latest |
73 | | - - name: Last Updated |
74 | | - image: https://img.shields.io/github/last-commit/cloudposse/terraform-example-module.svg?style=for-the-badge |
75 | | - url: https://github.com/cloudposse/terraform-example-module/commits |
76 | | - - name: Slack Community |
77 | | - image: https://slack.cloudposse.com/for-the-badge.svg |
78 | | - url: https://slack.cloudposse.com |
79 | | -contributors: [] |
80 | | ---- |
81 | 1 | # DELETE ME |
82 | 2 | # |
83 | 3 | # The above is the README configuration for the Example module itself. |
|
0 commit comments