Skip to content

Commit 981bb55

Browse files
goruhaosterman
goruha
and
osterman
authored
Use atmos to generate readme (#175)
* Use atmos to generate readme * Get rid of build harness * Update shared-terraform-module.yml * Update shared-terraform-module.yml * Create atmos.terraform-module.yaml * Migrate readme generation to atmos * Update shared-terraform-module.yml * Update shared-readme.yml * Update shared-terraform-module.yml * Update shared-readme.yml * Update shared-terraform-module.yml * Update shared-terraform-module.yml * Rename .github/atmos.terraform-module.yaml to .github/atmos/terraform-module.yaml * Update terraform-module.yaml * Update atmos.yaml * Apply suggestions from code review * Update terraform-module.yaml --------- Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <erik@cloudposse.com>
1 parent 6c4dcc8 commit 981bb55

File tree

18 files changed

+385
-2
lines changed

18 files changed

+385
-2
lines changed

‎.github/atmos/terraform-module.yaml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
docs:
2+
generate:
3+
readme:
4+
base-dir: .
5+
input:
6+
- "./README.yaml"
7+
template: "https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/README.md.gotmpl"
8+
output: "./README.md"
9+
terraform:
10+
source: .
11+
enabled: true
12+
format: "markdown table"
13+
show_providers: false
14+
show_inputs: true
15+
show_outputs: true
16+
sort_by: "name"
17+
hide_empty: false
18+
indent_level: 2
19+
20+
commands:
21+
- name: test init
22+
description: Initialize tests
23+
steps:
24+
- "make -C test/src init"
25+
26+
- name: test run
27+
description: Run tests
28+
steps:
29+
- "cd test/src && go mod tidy"
30+
- "cd test/src && go test -v -timeout 60m"
31+
32+
- name: test clean
33+
description: Clean tests
34+
steps:
35+
- "make -C test/src clean"
36+
- "rm -rf examples/*/.terraform examples/*/.terraform.lock.hcl"

‎.github/workflows/shared-ci-terraform.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ jobs:
5757
shell: bash -x -e -o pipefail {0}
5858
run: |
5959
# when running in test-harness, need to mark the directory safe for git operations
60-
make git-safe-directory
60+
git config --global --add safe.directory "$GITHUB_WORKSPACE";
6161
MODIFIED_MODULES=($(find . -type f -name "*.tf" | xargs -I{} dirname {} | sort | uniq | grep -v ^./.git/ || true))
6262
pass=true
6363
for relative_dir in "${MODIFIED_MODULES[@]}"; do

‎.github/workflows/shared-readme.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ jobs:
3838
fetch-depth: 0
3939
token: ${{ steps.github-app.outputs.token }}
4040

41-
- uses: cloudposse-github-actions/readme@v0
41+
- uses: cloudposse-github-actions/readme@v1
4242
with:
4343
token: ${{ steps.github-app.outputs.token }}
4444
readme_enabled: true

‎migrate/migrations/20250523/README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## what
2+
- Remove `Makefile`
3+
- Add `atmos.yaml`
4+
5+
## why
6+
- Replace `build-harness` with `atmos` for readme genration
7+
8+
## References
9+
* DEV-3229 Migrate from build-harness to atmos

‎migrate/migrations/20250523/repos-00‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
cloudposse/terraform-module-test
2+
cloudposse/terraform-aws-documentdb-cluster
3+
cloudposse/terraform-aws-managed-prometheus
4+
cloudposse/terraform-aws-ecs-web-app
5+
cloudposse/terraform-aws-elasticache-redis
6+
cloudposse/terraform-aws-rds-cluster
7+
cloudposse/terraform-aws-backup
8+
cloudposse/terraform-aws-helm-release
9+
cloudposse/terraform-aws-iam-policy
10+
cloudposse/terraform-aws-alb
11+
cloudposse/terraform-aws-vpc-peering
12+
cloudposse/terraform-aws-budgets
13+
cloudposse/terraform-aws-vpn-connection
14+
cloudposse/terraform-aws-route53-cluster-hostname
15+
cloudposse/terraform-aws-lambda-elasticsearch-cleanup
16+
cloudposse/terraform-aws-elasticsearch

‎migrate/migrations/20250523/repos-01‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
cloudposse/terraform-aws-s3-bucket
2+
cloudposse/terraform-aws-ecs-alb-service-task
3+
cloudposse/terraform-aws-route53-record
4+
cloudposse/terraform-aws-route53-alias
5+
cloudposse/terraform-aws-transfer-sftp
6+
cloudposse/terraform-aws-ses-lambda-forwarder
7+
cloudposse/terraform-aws-datadog-lambda-forwarder
8+
cloudposse/terraform-aws-cloudtrail-s3-bucket
9+
cloudposse/terraform-aws-cloudfront-cdn
10+
cloudposse/terraform-aws-cloudfront-s3-cdn
11+
cloudposse/terraform-aws-lb-s3-bucket
12+
cloudposse/terraform-aws-vpc-flow-logs-s3-bucket
13+
cloudposse/terraform-aws-s3-website
14+
cloudposse/terraform-aws-s3-log-storage
15+
cloudposse/terraform-aws-ec2-client-vpn
16+
cloudposse/terraform-aws-mwaa

‎migrate/migrations/20250523/repos-02‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
cloudposse/terraform-aws-sns-topic
2+
cloudposse/terraform-aws-service-control-policies
3+
cloudposse/terraform-aws-api-gateway
4+
cloudposse/terraform-aws-elasticache-memcached
5+
cloudposse/terraform-aws-eks-iam-role
6+
cloudposse/terraform-aws-codebuild
7+
cloudposse/terraform-aws-config
8+
cloudposse/terraform-aws-guardduty
9+
cloudposse/terraform-aws-security-hub
10+
cloudposse/terraform-aws-code-deploy
11+
cloudposse/terraform-aws-mq-broker
12+
cloudposse/terraform-aws-nlb
13+
cloudposse/terraform-datadog-platform
14+
cloudposse/terraform-aws-vpc-peering-multi-account
15+
cloudposse/terraform-aws-tfstate-backend
16+
cloudposse/terraform-aws-ecs-cloudwatch-autoscaling

‎migrate/migrations/20250523/repos-03‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
cloudposse/terraform-artifactory-kv-store
2+
cloudposse/terraform-aws-cloudtrail
3+
cloudposse/terraform-aws-eks-workers
4+
cloudposse/terraform-aws-sns-lambda-notify-slack
5+
cloudposse/terraform-aws-ecs-container-definition
6+
cloudposse/terraform-aws-eks-cluster
7+
cloudposse/terraform-aws-lambda-function
8+
cloudposse/terraform-aws-cloudwatch-logs
9+
cloudposse/terraform-aws-ecs-cloudwatch-sns-alarms
10+
cloudposse/terraform-aws-eks-node-group
11+
cloudposse/terraform-aws-eks-fargate-profile
12+
cloudposse/terraform-null-label
13+
cloudposse/terraform-example-module
14+
cloudposse/terraform-yaml-config
15+
cloudposse/terraform-aws-acm-request-certificate
16+
cloudposse/terraform-cloudflare-zone

‎migrate/migrations/20250523/repos-04‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
cloudposse/terraform-aws-datadog-integration
2+
cloudposse/terraform-aws-rds-cloudwatch-sns-alarms
3+
cloudposse/terraform-aws-cloudformation-stack-set
4+
cloudposse/terraform-aws-amplify-app
5+
cloudposse/terraform-aws-firewall-manager
6+
cloudposse/terraform-aws-rds
7+
cloudposse/terraform-aws-emr-cluster
8+
cloudposse/terraform-aws-ecr
9+
cloudposse/terraform-aws-iam-system-user
10+
cloudposse/terraform-aws-key-pair
11+
cloudposse/terraform-aws-lakeformation
12+
cloudposse/terraform-aws-inspector
13+
cloudposse/terraform-aws-iam-role
14+
cloudposse/terraform-aws-service-quotas
15+
cloudposse/terraform-aws-ssm-parameter-store
16+
cloudposse/terraform-aws-efs

‎migrate/migrations/20250523/repos-05‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
cloudposse/terraform-aws-vpc
2+
cloudposse/terraform-aws-glue
3+
cloudposse/terraform-aws-ec2-instance
4+
cloudposse/terraform-aws-dynamodb
5+
cloudposse/terraform-aws-ssm-patch-manager
6+
cloudposse/terraform-aws-utils
7+
cloudposse/terraform-aws-ecs-cluster
8+
cloudposse/terraform-aws-ec2-autoscale-group
9+
cloudposse/terraform-aws-alb-ingress
10+
cloudposse/terraform-aws-dynamic-subnets
11+
cloudposse/terraform-spacelift-cloud-infrastructure-automation
12+
cloudposse/terraform-aws-ecs-codepipeline
13+
cloudposse/terraform-aws-ec2-bastion-server
14+
cloudposse/terraform-aws-managed-grafana
15+
cloudposse/terraform-cloudflare-waf-rulesets
16+
cloudposse/terraform-aws-transit-gateway

0 commit comments

Comments
 (0)