Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use new readme action #71

Merged
merged 6 commits into from
May 7, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 0 additions & 80 deletions README.yaml
Original file line number Diff line number Diff line change
@@ -1,83 +1,3 @@
########################################################################################################################
########################################################################################################################
########################################################################################################################
# DELETE ME
#
# This is the README configuration for the Example module itself.
# Delete this (up to and including the line with `---`) and fill in
# the template below the dashes

# Name of this project
name: terraform-example-module

# License of this project
license: "APACHE2"

# Copyrights
copyrights:
- name: "Cloud Posse, LLC"
url: "https://cloudposse.com"
year: "2021"

# Canonical GitHub repo
github_repo: cloudposse/terraform-example-module

description: |-
This is an example project to provide all the scaffolding for a typical well-built Cloud Posse
Terraform module for AWS resources. It's a template repository you can
use when creating new repositories. This is not a useful module by itself.

quickstart: |-
1. Use this repo as a template for a new repo.
2. Check out the new repo and create a `git` branch to work on.
3. Replace the Terraform code at the root of the repo with the code you want to publish.
4. Replace the code in `examples/complete` with Terraform code that will make a good automated test.
Please keep `context.tf` and `fixtures.us-east-2.tfvars` in place and change only `name`, leaving
`region`, `namespace`, `environment`, and `stage` as is. Provide outputs that will be useful for testing.
5. Update `test/src/examples_complete_test.go` to verify the outputs of running `terraform apply` on `examples/complete`.
6. Run `make github/init` to update the repo with the current Cloud Posse framework files (e.g. `CODEOWNERS`).
7. Run `make pr/auto-format` to format the Terraform code and generate documentation.
8. Commit everything to `git` and open your first PR on the new repo.

references:
- name: "Cloud Posse Documentation"
url: "https://docs.cloudposse.com"
description: "The Cloud Posse Developer Hub (documentation)"
- name: "Terraform Standard Module Structure"
description: "HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories."
url: "https://www.terraform.io/docs/language/modules/develop/structure.html"
- name: "Terraform Module Requirements"
description: "HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy."
url: "https://www.terraform.io/docs/registry/modules/publish.html#requirements"
- name: "Terraform Version Pinning"
description: "The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration"
url: "https://www.terraform.io/docs/language/settings/index.html#specifying-a-required-terraform-version"


# List any related terraform modules that this module may be used with or that this module depends on.

# List any related terraform modules that this module may be used with or that this module depends on.
related:
- name: "Example App"
url: "https://github.com/cloudposse/example-app"
description: "Example application for CI/CD demonstrations of Codefresh"


badges:
- name: Last Updated
image: https://img.shields.io/github/last-commit/cloudposse/terraform-example-module.svg?style=for-the-badge
url: https://github.com/cloudposse/terraform-example-module/commits
- name: Latest Release
image: https://img.shields.io/github/release/cloudposse/terraform-example-module.svg?style=for-the-badge
url: https://github.com/cloudposse/terraform-example-module/releases/latest
- name: Last Updated
image: https://img.shields.io/github/last-commit/cloudposse/terraform-example-module.svg?style=for-the-badge
url: https://github.com/cloudposse/terraform-example-module/commits
- name: Slack Community
image: https://slack.cloudposse.com/for-the-badge.svg
url: https://slack.cloudposse.com
contributors: []
---
# DELETE ME
#
# The above is the README configuration for the Example module itself.
Expand Down