diff --git a/README.md.simple.gotmpl b/README.md.simple.gotmpl new file mode 100644 index 0000000..597e68b --- /dev/null +++ b/README.md.simple.gotmpl @@ -0,0 +1,82 @@ +{{- defineDatasource "config" .Env.README_YAML -}} +{{- defineDatasource "includes" (env.Getenv "README_INCLUDES" | default "./") -}} +{{- $deprecated := has (ds "config") "deprecated" }} + + + +{{ if $deprecated -}} +# (deprecated) {{(ds "config").name}} +{{- else }} + # {{(ds "config").name}} +{{ end }} +{{- if $deprecated -}}Deprecated{{- end -}} + + + +{{- if $deprecated }} +## Deprecated + +{{ if has (ds "config").deprecated "notice" }} + {{- (ds "config").deprecated.notice }} +{{- else }} +> [!IMPORTANT] +> This module is no longer actively maintained +{{- end }} +{{- end }} + +{{ if has (ds "config") "description" }} +{{(ds "config").description }} +{{- end }} +{{- else }} +{{- if has (ds "config") "description" }} +{{ (ds "config").description }} +{{- end }} +{{- end }} + +{{ if has (ds "config") "introduction" }} +## Introduction + +{{ (ds "config").introduction }} +{{ end }} + +{{ if has (ds "config") "usage" }} +## Usage + +{{ if not $deprecated -}} +{{ if has (ds "config") "quickstart" -}} +## Quick Start + +{{ (ds "config").quickstart -}} +{{ end }} + +{{- if has (ds "config") "examples" }} +## Examples + +{{ (ds "config").examples }} +{{ end }} + +{{ if has (ds "config") "include" }} +{{ range $file := (datasource "config").include -}} +{{ (include "includes" $file) }} +{{- end }} +{{- end }} +{{- end}} diff --git a/migrate/migrations/20241112/README.md b/migrate/migrations/20241112/README.md new file mode 100644 index 0000000..57374f5 --- /dev/null +++ b/migrate/migrations/20241112/README.md @@ -0,0 +1,6 @@ +## what +- Copy CHANGELOG.md to `src/CHANGELOG.md` +- Generate `src/README.md` from `README.yaml` + +## why +- `atmos vendor` should get readme files diff --git a/migrate/migrations/20241112/repos-00 b/migrate/migrations/20241112/repos-00 new file mode 100644 index 0000000..b5190b0 --- /dev/null +++ b/migrate/migrations/20241112/repos-00 @@ -0,0 +1,16 @@ +cloudposse-terraform-components/aws-zscaler +cloudposse-terraform-components/aws-vpc-peering +cloudposse-terraform-components/aws-vpc-flow-logs-bucket +cloudposse-terraform-components/aws-vpc +cloudposse-terraform-components/aws-tgw-hub-connector +cloudposse-terraform-components/aws-tfstate-backend +cloudposse-terraform-components/aws-ssm-parameters +cloudposse-terraform-components/aws-spacelift-worker-pool-asg +cloudposse-terraform-components/aws-spacelift-spaces +cloudposse-terraform-components/aws-spa-s3-cloudfront +cloudposse-terraform-components/aws-sns-topic +cloudposse-terraform-components/aws-snowflake-database +cloudposse-terraform-components/aws-snowflake-account +cloudposse-terraform-components/aws-ses +cloudposse-terraform-components/aws-s3-bucket +cloudposse-terraform-components/aws-redshift-serverless diff --git a/migrate/migrations/20241112/repos-01 b/migrate/migrations/20241112/repos-01 new file mode 100644 index 0000000..1f1f028 --- /dev/null +++ b/migrate/migrations/20241112/repos-01 @@ -0,0 +1,16 @@ +cloudposse-terraform-components/aws-redshift +cloudposse-terraform-components/aws-rds +cloudposse-terraform-components/aws-philips-labs-github-runners +cloudposse-terraform-components/aws-opsgenie-team +cloudposse-terraform-components/aws-network-firewall +cloudposse-terraform-components/aws-mwaa +cloudposse-terraform-components/aws-mq-broker +cloudposse-terraform-components/aws-managed-prometheus-workspace +cloudposse-terraform-components/aws-managed-grafana-workspace +cloudposse-terraform-components/aws-lakeformation +cloudposse-terraform-components/aws-kinesis-stream +cloudposse-terraform-components/aws-iam-service-linked-roles +cloudposse-terraform-components/aws-iam-role +cloudposse-terraform-components/aws-glue-schema +cloudposse-terraform-components/aws-glue-job +cloudposse-terraform-components/aws-glue-crawler diff --git a/migrate/migrations/20241112/repos-02 b/migrate/migrations/20241112/repos-02 new file mode 100644 index 0000000..1e3a3ae --- /dev/null +++ b/migrate/migrations/20241112/repos-02 @@ -0,0 +1,16 @@ +cloudposse-terraform-components/aws-glue-connection +cloudposse-terraform-components/aws-glue-catalog-table +cloudposse-terraform-components/aws-global-accelerator-endpoint-group +cloudposse-terraform-components/aws-global-accelerator +cloudposse-terraform-components/aws-github-runners +cloudposse-terraform-components/aws-github-action-token-rotator +cloudposse-terraform-components/aws-elasticsearch +cloudposse-terraform-components/aws-elasticache-redis +cloudposse-terraform-components/aws-eks-tailscale +cloudposse-terraform-components/aws-eks-storage-class +cloudposse-terraform-components/aws-eks-redis-operator +cloudposse-terraform-components/aws-eks-redis +cloudposse-terraform-components/aws-eks-karpenter-controller +cloudposse-terraform-components/aws-eks-idp-roles +cloudposse-terraform-components/aws-eks-github-actions-runner +cloudposse-terraform-components/aws-eks-echo-server diff --git a/migrate/migrations/20241112/repos-03 b/migrate/migrations/20241112/repos-03 new file mode 100644 index 0000000..778368e --- /dev/null +++ b/migrate/migrations/20241112/repos-03 @@ -0,0 +1,16 @@ +cloudposse-terraform-components/aws-eks-cert-manager +cloudposse-terraform-components/aws-efs +cloudposse-terraform-components/aws-ecr +cloudposse-terraform-components/aws-dns-primary +cloudposse-terraform-components/aws-dns-delegated +cloudposse-terraform-components/aws-datadog-monitor +cloudposse-terraform-components/aws-datadog-integration +cloudposse-terraform-components/aws-config-bucket +cloudposse-terraform-components/aws-cloudwatch-logs +cloudposse-terraform-components/aws-cloudtrail-bucket +cloudposse-terraform-components/aws-cloudtrail +cloudposse-terraform-components/aws-bastion +cloudposse-terraform-components/aws-backup +cloudposse-terraform-components/aws-aurora-postgres +cloudposse-terraform-components/aws-account-settings +cloudposse-terraform-components/aws-account-map diff --git a/migrate/migrations/20241112/repos-04 b/migrate/migrations/20241112/repos-04 new file mode 100644 index 0000000..5563826 --- /dev/null +++ b/migrate/migrations/20241112/repos-04 @@ -0,0 +1,16 @@ +cloudposse-terraform-components/aws-account +cloudposse-terraform-components/aws-access-analyzer +cloudposse-terraform-components/aws-waf +cloudposse-terraform-components/aws-tgw-spoke +cloudposse-terraform-components/aws-tgw-hub +cloudposse-terraform-components/aws-strongdm +cloudposse-terraform-components/aws-sso-saml-provider +cloudposse-terraform-components/aws-sqs-queue +cloudposse-terraform-components/aws-eks-spacelift-worker-pool +cloudposse-terraform-components/aws-eks-spacelift-worker-pool-controller +cloudposse-terraform-components/aws-spacelift-admin-stack +cloudposse-terraform-components/aws-site-to-site-vpn +cloudposse-terraform-components/aws-sftp +cloudposse-terraform-components/aws-security-hub +cloudposse-terraform-components/aws-runs-on +cloudposse-terraform-components/aws-route53-resolver-dns-firewall diff --git a/migrate/migrations/20241112/repos-05 b/migrate/migrations/20241112/repos-05 new file mode 100644 index 0000000..8f2970e --- /dev/null +++ b/migrate/migrations/20241112/repos-05 @@ -0,0 +1,16 @@ +cloudposse-terraform-components/aws-msk +cloudposse-terraform-components/aws-memorydb +cloudposse-terraform-components/aws-managed-grafana-data-source-managed-prometheus +cloudposse-terraform-components/aws-managed-grafana-data-source-loki +cloudposse-terraform-components/aws-managed-grafana-dashboard +cloudposse-terraform-components/aws-managed-grafana-api-key +cloudposse-terraform-components/aws-macie +cloudposse-terraform-components/aws-lambda +cloudposse-terraform-components/aws-kms +cloudposse-terraform-components/aws-ipam +cloudposse-terraform-components/aws-guardduty +cloudposse-terraform-components/aws-glue-workflow +cloudposse-terraform-components/aws-glue-trigger +cloudposse-terraform-components/aws-glue-registry +cloudposse-terraform-components/aws-glue-iam +cloudposse-terraform-components/aws-glue-catalog-database diff --git a/migrate/migrations/20241112/repos-06 b/migrate/migrations/20241112/repos-06 new file mode 100644 index 0000000..5b3192d --- /dev/null +++ b/migrate/migrations/20241112/repos-06 @@ -0,0 +1,16 @@ +cloudposse-terraform-components/aws-github-webhook +cloudposse-terraform-components/aws-github-oidc-role +cloudposse-terraform-components/aws-github-oidc-provider +cloudposse-terraform-components/aws-eventbridge +cloudposse-terraform-components/aws-eks-reloader +cloudposse-terraform-components/aws-eks-promtail +cloudposse-terraform-components/aws-eks-prometheus-scraper +cloudposse-terraform-components/aws-eks-metrics-server +cloudposse-terraform-components/aws-eks-loki +cloudposse-terraform-components/aws-eks-keda +cloudposse-terraform-components/aws-eks-karpenter-node-pool +cloudposse-terraform-components/aws-eks-external-secrets-operator +cloudposse-terraform-components/aws-eks-external-dns +cloudposse-terraform-components/aws-eks-datadog-agent +cloudposse-terraform-components/aws-eks-cluster +cloudposse-terraform-components/aws-eks-node-termination-handler diff --git a/migrate/migrations/20241112/repos-07 b/migrate/migrations/20241112/repos-07 new file mode 100644 index 0000000..9ce9548 --- /dev/null +++ b/migrate/migrations/20241112/repos-07 @@ -0,0 +1,16 @@ +cloudposse-terraform-components/aws-eks-argocd +cloudposse-terraform-components/aws-argocd-github-repo +cloudposse-terraform-components/aws-eks-alb-controller-ingress-group +cloudposse-terraform-components/aws-eks-alb-controller-ingress-class +cloudposse-terraform-components/aws-eks-alb-controller +cloudposse-terraform-components/aws-eks-actions-runner-controller +cloudposse-terraform-components/aws-ecs-service +cloudposse-terraform-components/aws-ecs +cloudposse-terraform-components/aws-ec2-instance +cloudposse-terraform-components/aws-ec2-client-vpn +cloudposse-terraform-components/aws-dynamodb +cloudposse-terraform-components/aws-documentdb +cloudposse-terraform-components/aws-dms-replication-task +cloudposse-terraform-components/aws-dms-replication-instance +cloudposse-terraform-components/aws-dms-iam +cloudposse-terraform-components/aws-dms-endpoint diff --git a/migrate/migrations/20241112/repos-08 b/migrate/migrations/20241112/repos-08 new file mode 100644 index 0000000..a302f40 --- /dev/null +++ b/migrate/migrations/20241112/repos-08 @@ -0,0 +1,16 @@ +cloudposse-terraform-components/aws-datadog-synthetics-private-location +cloudposse-terraform-components/aws-datadog-synthetics +cloudposse-terraform-components/aws-datadog-private-location-ecs +cloudposse-terraform-components/aws-datadog-logs-archive +cloudposse-terraform-components/aws-datadog-lambda-forwarder +cloudposse-terraform-components/aws-datadog-credentials +cloudposse-terraform-components/aws-cognito +cloudposse-terraform-components/aws-cloudmap-namespace +cloudposse-terraform-components/aws-team-roles +cloudposse-terraform-components/aws-teams +cloudposse-terraform-components/aws-ssosync +cloudposse-terraform-components/aws-saml +cloudposse-terraform-components/aws-identity-center +cloudposse-terraform-components/aws-shield +cloudposse-terraform-components/aws-inspector2 +cloudposse-terraform-components/aws-inspector diff --git a/migrate/migrations/20241112/repos-09 b/migrate/migrations/20241112/repos-09 new file mode 100644 index 0000000..bfef3f3 --- /dev/null +++ b/migrate/migrations/20241112/repos-09 @@ -0,0 +1,15 @@ +cloudposse-terraform-components/aws-config +cloudposse-terraform-components/aws-auth0-tenant +cloudposse-terraform-components/aws-auth0-connection +cloudposse-terraform-components/aws-auth0-app +cloudposse-terraform-components/aws-aurora-postgres-resources +cloudposse-terraform-components/aws-aurora-mysql-resources +cloudposse-terraform-components/aws-aurora-mysql +cloudposse-terraform-components/aws-athena +cloudposse-terraform-components/aws-api-gateway-rest-api +cloudposse-terraform-components/aws-api-gateway-account-settings +cloudposse-terraform-components/aws-amplify +cloudposse-terraform-components/aws-alb +cloudposse-terraform-components/aws-acm +cloudposse-terraform-components/aws-account-quotas +cloudposse-terraform-components/aws-alb-experimental diff --git a/migrate/migrations/20241112/repos.sh b/migrate/migrations/20241112/repos.sh new file mode 100755 index 0000000..f6ca6f3 --- /dev/null +++ b/migrate/migrations/20241112/repos.sh @@ -0,0 +1,5 @@ +#!/bin/bash +gh repo list cloudposse-terraform-components --limit 500 --json name,owner \ + --jq '.[] | select(.name | test("^aws")) | .owner.login + "/" + .name' > repos.txt + +split -d -l 16 repos.txt repos- diff --git a/migrate/migrations/20241112/repos.txt b/migrate/migrations/20241112/repos.txt new file mode 100644 index 0000000..81a8ee0 --- /dev/null +++ b/migrate/migrations/20241112/repos.txt @@ -0,0 +1,159 @@ +cloudposse-terraform-components/aws-zscaler +cloudposse-terraform-components/aws-vpc-peering +cloudposse-terraform-components/aws-vpc-flow-logs-bucket +cloudposse-terraform-components/aws-vpc +cloudposse-terraform-components/aws-tgw-hub-connector +cloudposse-terraform-components/aws-tfstate-backend +cloudposse-terraform-components/aws-ssm-parameters +cloudposse-terraform-components/aws-spacelift-worker-pool-asg +cloudposse-terraform-components/aws-spacelift-spaces +cloudposse-terraform-components/aws-spa-s3-cloudfront +cloudposse-terraform-components/aws-sns-topic +cloudposse-terraform-components/aws-snowflake-database +cloudposse-terraform-components/aws-snowflake-account +cloudposse-terraform-components/aws-ses +cloudposse-terraform-components/aws-s3-bucket +cloudposse-terraform-components/aws-redshift-serverless +cloudposse-terraform-components/aws-redshift +cloudposse-terraform-components/aws-rds +cloudposse-terraform-components/aws-philips-labs-github-runners +cloudposse-terraform-components/aws-opsgenie-team +cloudposse-terraform-components/aws-network-firewall +cloudposse-terraform-components/aws-mwaa +cloudposse-terraform-components/aws-mq-broker +cloudposse-terraform-components/aws-managed-prometheus-workspace +cloudposse-terraform-components/aws-managed-grafana-workspace +cloudposse-terraform-components/aws-lakeformation +cloudposse-terraform-components/aws-kinesis-stream +cloudposse-terraform-components/aws-iam-service-linked-roles +cloudposse-terraform-components/aws-iam-role +cloudposse-terraform-components/aws-glue-schema +cloudposse-terraform-components/aws-glue-job +cloudposse-terraform-components/aws-glue-crawler +cloudposse-terraform-components/aws-glue-connection +cloudposse-terraform-components/aws-glue-catalog-table +cloudposse-terraform-components/aws-global-accelerator-endpoint-group +cloudposse-terraform-components/aws-global-accelerator +cloudposse-terraform-components/aws-github-runners +cloudposse-terraform-components/aws-github-action-token-rotator +cloudposse-terraform-components/aws-elasticsearch +cloudposse-terraform-components/aws-elasticache-redis +cloudposse-terraform-components/aws-eks-tailscale +cloudposse-terraform-components/aws-eks-storage-class +cloudposse-terraform-components/aws-eks-redis-operator +cloudposse-terraform-components/aws-eks-redis +cloudposse-terraform-components/aws-eks-karpenter-controller +cloudposse-terraform-components/aws-eks-idp-roles +cloudposse-terraform-components/aws-eks-github-actions-runner +cloudposse-terraform-components/aws-eks-echo-server +cloudposse-terraform-components/aws-eks-cert-manager +cloudposse-terraform-components/aws-efs +cloudposse-terraform-components/aws-ecr +cloudposse-terraform-components/aws-dns-primary +cloudposse-terraform-components/aws-dns-delegated +cloudposse-terraform-components/aws-datadog-monitor +cloudposse-terraform-components/aws-datadog-integration +cloudposse-terraform-components/aws-config-bucket +cloudposse-terraform-components/aws-cloudwatch-logs +cloudposse-terraform-components/aws-cloudtrail-bucket +cloudposse-terraform-components/aws-cloudtrail +cloudposse-terraform-components/aws-bastion +cloudposse-terraform-components/aws-backup +cloudposse-terraform-components/aws-aurora-postgres +cloudposse-terraform-components/aws-account-settings +cloudposse-terraform-components/aws-account-map +cloudposse-terraform-components/aws-account +cloudposse-terraform-components/aws-access-analyzer +cloudposse-terraform-components/aws-waf +cloudposse-terraform-components/aws-tgw-spoke +cloudposse-terraform-components/aws-tgw-hub +cloudposse-terraform-components/aws-strongdm +cloudposse-terraform-components/aws-sso-saml-provider +cloudposse-terraform-components/aws-sqs-queue +cloudposse-terraform-components/aws-eks-spacelift-worker-pool +cloudposse-terraform-components/aws-eks-spacelift-worker-pool-controller +cloudposse-terraform-components/aws-spacelift-admin-stack +cloudposse-terraform-components/aws-site-to-site-vpn +cloudposse-terraform-components/aws-sftp +cloudposse-terraform-components/aws-security-hub +cloudposse-terraform-components/aws-runs-on +cloudposse-terraform-components/aws-route53-resolver-dns-firewall +cloudposse-terraform-components/aws-msk +cloudposse-terraform-components/aws-memorydb +cloudposse-terraform-components/aws-managed-grafana-data-source-managed-prometheus +cloudposse-terraform-components/aws-managed-grafana-data-source-loki +cloudposse-terraform-components/aws-managed-grafana-dashboard +cloudposse-terraform-components/aws-managed-grafana-api-key +cloudposse-terraform-components/aws-macie +cloudposse-terraform-components/aws-lambda +cloudposse-terraform-components/aws-kms +cloudposse-terraform-components/aws-ipam +cloudposse-terraform-components/aws-guardduty +cloudposse-terraform-components/aws-glue-workflow +cloudposse-terraform-components/aws-glue-trigger +cloudposse-terraform-components/aws-glue-registry +cloudposse-terraform-components/aws-glue-iam +cloudposse-terraform-components/aws-glue-catalog-database +cloudposse-terraform-components/aws-github-webhook +cloudposse-terraform-components/aws-github-oidc-role +cloudposse-terraform-components/aws-github-oidc-provider +cloudposse-terraform-components/aws-eventbridge +cloudposse-terraform-components/aws-eks-reloader +cloudposse-terraform-components/aws-eks-promtail +cloudposse-terraform-components/aws-eks-prometheus-scraper +cloudposse-terraform-components/aws-eks-metrics-server +cloudposse-terraform-components/aws-eks-loki +cloudposse-terraform-components/aws-eks-keda +cloudposse-terraform-components/aws-eks-karpenter-node-pool +cloudposse-terraform-components/aws-eks-external-secrets-operator +cloudposse-terraform-components/aws-eks-external-dns +cloudposse-terraform-components/aws-eks-datadog-agent +cloudposse-terraform-components/aws-eks-cluster +cloudposse-terraform-components/aws-eks-node-termination-handler +cloudposse-terraform-components/aws-eks-argocd +cloudposse-terraform-components/aws-argocd-github-repo +cloudposse-terraform-components/aws-eks-alb-controller-ingress-group +cloudposse-terraform-components/aws-eks-alb-controller-ingress-class +cloudposse-terraform-components/aws-eks-alb-controller +cloudposse-terraform-components/aws-eks-actions-runner-controller +cloudposse-terraform-components/aws-ecs-service +cloudposse-terraform-components/aws-ecs +cloudposse-terraform-components/aws-ec2-instance +cloudposse-terraform-components/aws-ec2-client-vpn +cloudposse-terraform-components/aws-dynamodb +cloudposse-terraform-components/aws-documentdb +cloudposse-terraform-components/aws-dms-replication-task +cloudposse-terraform-components/aws-dms-replication-instance +cloudposse-terraform-components/aws-dms-iam +cloudposse-terraform-components/aws-dms-endpoint +cloudposse-terraform-components/aws-datadog-synthetics-private-location +cloudposse-terraform-components/aws-datadog-synthetics +cloudposse-terraform-components/aws-datadog-private-location-ecs +cloudposse-terraform-components/aws-datadog-logs-archive +cloudposse-terraform-components/aws-datadog-lambda-forwarder +cloudposse-terraform-components/aws-datadog-credentials +cloudposse-terraform-components/aws-cognito +cloudposse-terraform-components/aws-cloudmap-namespace +cloudposse-terraform-components/aws-team-roles +cloudposse-terraform-components/aws-teams +cloudposse-terraform-components/aws-ssosync +cloudposse-terraform-components/aws-saml +cloudposse-terraform-components/aws-identity-center +cloudposse-terraform-components/aws-shield +cloudposse-terraform-components/aws-inspector2 +cloudposse-terraform-components/aws-inspector +cloudposse-terraform-components/aws-config +cloudposse-terraform-components/aws-auth0-tenant +cloudposse-terraform-components/aws-auth0-connection +cloudposse-terraform-components/aws-auth0-app +cloudposse-terraform-components/aws-aurora-postgres-resources +cloudposse-terraform-components/aws-aurora-mysql-resources +cloudposse-terraform-components/aws-aurora-mysql +cloudposse-terraform-components/aws-athena +cloudposse-terraform-components/aws-api-gateway-rest-api +cloudposse-terraform-components/aws-api-gateway-account-settings +cloudposse-terraform-components/aws-amplify +cloudposse-terraform-components/aws-alb +cloudposse-terraform-components/aws-acm +cloudposse-terraform-components/aws-account-quotas +cloudposse-terraform-components/aws-alb-experimental diff --git a/migrate/migrations/20241112/script.sh b/migrate/migrations/20241112/script.sh new file mode 100644 index 0000000..20b7402 --- /dev/null +++ b/migrate/migrations/20241112/script.sh @@ -0,0 +1,10 @@ +title "Fix readme" + +if [ -f CHANGELOG.md ]; then + mv CHANGELOG.md ./src + git add ./src/CHANGELOG.md +fi + + +# Merge the PR +# auto_merge diff --git a/migrate/run.sh b/migrate/run.sh index 7c43704..1e3d90c 100755 --- a/migrate/run.sh +++ b/migrate/run.sh @@ -51,7 +51,7 @@ git reset --hard origin/${default_branch} git config --local core.excludesFile ${MIGRATE_PATH}/.gitignore # Clone the `build-harness` to a centralized location so we don't have to do it for every migration -if [ ! -d "${MIGRATE_PATH}/tmp/build-harness" ]; then +if [ ! -d "$(dirname ${curdir})/build-harness" ]; then git clone https://github.com/cloudposse/build-harness.git "$(dirname ${curdir})/build-harness" fi