diff --git a/.github/atmos/customer.yaml b/.github/atmos/customer.yaml new file mode 100644 index 00000000..fb39395c --- /dev/null +++ b/.github/atmos/customer.yaml @@ -0,0 +1,28 @@ +docs: + generate: + readme: + base-dir: . + input: + - "./README.yaml" + - get_support: true + template: "https://raw.githubusercontent.com/cloudposse/.github/refs/heads/add-template-for-repos-without-marketing/README.md.simple.gotmpl" + output: "./README.md" + terraform: + source: . + enabled: false + format: "markdown table" + show_providers: false + show_inputs: true + show_outputs: true + sort_by: "name" + hide_empty: false + indent_level: 2 + +commands: +- name: readme + steps: + - "atmos docs generate readme" + +settings: + telemetry: + enabled: false diff --git a/README.md.simple.gotmpl b/README.md.simple.gotmpl new file mode 100644 index 00000000..84a3506a --- /dev/null +++ b/README.md.simple.gotmpl @@ -0,0 +1,402 @@ +{{- defineDatasource "config" .Env.README_YAML -}} +{{- defineDatasource "includes" (env.Getenv "README_INCLUDES" | default "./") -}} +{{- $deprecated := has (ds "config") "deprecated" }} +{{- $is_terraform := (strings.Contains "terraform-" ((ds "config").github_repo)) -}} +{{- $utm_link := printf "%%s?utm_source=%s&utm_medium=%s&utm_campaign=%s&utm_content=%s" "github" "readme" (ds "config").github_repo "%s" -}} +{{- $banner := printf "https://github.com/%s/blob/main/.github/banner.png?raw=true" (ds "config").github_repo -}} +{{- $homepage := printf $utm_link "https://cpco.io/homepage" "" -}} +{{- $logo := "https://cloudposse.com/logo-300x69.svg" -}} +{{- $terraform_modules := printf $utm_link "https://cpco.io/terraform-modules" "terraform_modules" -}} +{{- $slack := printf $utm_link "https://cpco.io/slack" "slack" -}} +{{- $commercial_support := printf $utm_link "https://cpco.io/commercial-support" "commercial_support" -}} +{{- $office_hours := printf $utm_link "https://cloudposse.com/office-hours" "office_hours" -}} +{{- $newsletter := printf $utm_link "https://cpco.io/newsletter" "newsletter" -}} +{{- $cta := printf "\"Request" $commercial_support -}} +{{- $context := dict "is_terraform" $is_terraform "utm_link" $utm_link "commercial_support" $commercial_support "cta" $cta -}} +{{- $sections := slice "introduction" "quickstart" "examples" -}} +{{- define "nonEmptySections" -}} +{{- range . -}}{{ $sectionContent := index (ds "config") . -}}{{ if and $sectionContent (gt (len $sectionContent) 2048) -}}{{ . }} {{ end -}}{{ end -}} +{{- end -}} +{{- $firstNonEmptySection := (tmpl.Exec "nonEmptySections" $sections) | strings.TrimSpace | regexp.Replace " .*" "" -}} + +{{/* Inspired https://github.com/Dirrk/action-docs/blob/master/src/default_template.tpl */}} +{{- define "escape_chars" }}{{ . | strings.ReplaceAll "_" "\\_" | strings.ReplaceAll "|" "\\|" | strings.ReplaceAll "*" "\\*" }}{{- end }} +{{- define "sanatize_string" }}{{ . | strings.ReplaceAll "\n\n" "

" | strings.ReplaceAll " \n" "
" | strings.ReplaceAll "\n" "
" | tmpl.Exec "escape_chars" }}{{- end }} + +{{- define "tip_use_atmos" }} +{{- if .is_terraform }} +> [!TIP] +> #### πŸ‘½ Use Atmos with Terraform +> Cloud Posse uses [`atmos`](https://atmos.tools) to easily orchestrate multiple environments using Terraform.
+> Works with [Github Actions](https://atmos.tools/integrations/github-actions/), [Atlantis](https://atmos.tools/integrations/atlantis), or [Spacelift](https://atmos.tools/integrations/spacelift). +> +>
+> Watch demo of using Atmos with Terraform +>
+> Example of running atmos to manage infrastructure from our Quick Start tutorial. +> +{{- end }} +{{- end }} +{{- define "tip_use_reference_architecture" -}} +{{- if .is_terraform }} +> [!TIP] +> #### Use Terraform Reference Architectures for AWS +> +> Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly. +> +> βœ… We build it together with your team.
+> βœ… Your team owns everything.
+> βœ… 100% Open Source and backed by fanatical support.
+> +> {{ .cta }} +>
πŸ“š Learn More +> +>
+> +> Cloud Posse is the leading [**DevOps Accelerator**]({{ .commercial_support }}) for funded startups and enterprises. +> +> *Your team can operate like a pro today.* +> +> Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed. +> #### Day-0: Your Foundation for Success +> - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code. +> - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases. +> - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance. +> - **Security Baseline.** Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations. +> - **GitOps.** Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions. +> +> {{ .cta }} +> +> #### Day-2: Your Operational Mastery +> - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency. +> - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it. +> - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity. +> - **Code Reviews.** Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration. +> - **Bug Fixes.** Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly. +> - **Migration Assistance.** Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value. +> - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate. +> +> {{ .cta }} +> +
+{{- end -}} +{{- end }} + + +{{ if $deprecated -}} +# (deprecated) {{(ds "config").name}} +Deprecated +{{- else }} + {{- if (file.Exists ".github/banner.png") -}} + Project Banner
+ {{- else -}} + # {{(ds "config").name}} + {{- end }} +{{ end }} + +{{ if not $deprecated -}} + {{ if and (file.Exists ".github/banner.png") (has (ds "config") "badges") }}

{{- end -}} +{{ end }} + +{{- if has (ds "config") "badges" -}} + {{- range $badge := (ds "config").badges -}} + {{- printf "\"%s\"/" $badge.url $badge.image $badge.name -}} + {{- end -}} +{{- end }} + +{{- if has (ds "config") "get_support" -}} +Get Support +{{- end }} + +{{ if not $deprecated -}} + {{ if and (file.Exists ".github/banner.png") (has (ds "config") "badges") }}

{{- end -}} +{{ end }} + + + +{{ if has (ds "config") "logo" }} + +{{(ds +{{- end -}} + +{{- if $deprecated }} +## Deprecated + +{{ if has (ds "config").deprecated "notice" }} + {{- (ds "config").deprecated.notice }} +{{- else }} +> [!IMPORTANT] +> This module is no longer actively maintained +{{- end }} +{{- if $ }} + +We literally have *hundreds of other terraform modules* that are Open Source and well-maintained. Check them out! +{{- end }} + +{{ if has (ds "config") "description" }} +### Historical Description + +{{(ds "config").description }} +{{- end }} +{{- else }} +{{- if has (ds "config") "description" }} +{{ (ds "config").description }} +{{- end }} +{{- end }} +{{ if has (ds "config") "screenshots" }} +## Screenshots + +{{ range $screenshot := (ds "config").screenshots }} +{{- if or ( $screenshot.url | regexp.Match "\\.mp4$") ($screenshot.url | regexp.Match "\\.mp4\\?.*") -}} + +{{- else -}} +{{ $screenshot.name }} +{{- end -}} +*{{ $screenshot.description }}* +{{ end }} +{{- end }} +{{ template "tip_use_atmos" $context }} + +{{ if has (ds "config") "introduction" }} +## Introduction + +{{ (ds "config").introduction }} +{{ end }} +{{ if eq "introduction" $firstNonEmptySection }}{{ template "tip_use_reference_architecture" $context }}{{- end }} + +{{ if has (ds "config") "usage" }} +## Usage + +{{ (ds "config").usage -}} +{{- if $is_terraform }} + +> [!IMPORTANT] +> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation +> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version +> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic +> approach for updating versions to avoid unexpected changes. + +{{ end }} +{{ end }} +{{- if eq "usage" $firstNonEmptySection }}{{ template "tip_use_reference_architecture" $context }}{{- end }} + +{{ if not $deprecated -}} +{{ if has (ds "config") "quickstart" -}} +## Quick Start + +{{ (ds "config").quickstart -}} +{{ end }} +{{- if eq "quickstart" $firstNonEmptySection }}{{ template "tip_use_reference_architecture" $context }}{{- end }} + +{{- if has (ds "config") "examples" }} +## Examples + +{{ (ds "config").examples }} +{{ end }} +{{- if eq "examples" $firstNonEmptySection }}{{ template "tip_use_reference_architecture" $context }}{{- end }} + + +{{ if has (ds "config") "terraform_docs" }} + +{{ (ds "config").terraform_docs }} + +{{ end }} + +{{- $action := (datasource "config") -}} +{{ if has $action "inputs" }} +## Inputs + +| Name | Description | Default | Required | +|------|-------------|---------|----------| +{{- range $key, $input := $action.inputs }} +| {{ tmpl.Exec "escape_chars" $key }} | {{ if (has $input "description") }}{{ tmpl.Exec "sanatize_string" $input.description }}{{ else }}{{ tmpl.Exec "escape_chars" $key }}{{ end }} | {{ if (has $input "default") }}{{ tmpl.Exec "sanatize_string" $input.default }}{{ else }}N/A{{ end }} | {{ if (has $input "required") }}{{ $input.required }}{{ else }}false{{ end }} | +{{- end }} + +{{- end }} + +{{ if has $action "outputs" }} +## Outputs + +| Name | Description | +|------|-------------| +{{- range $key, $output := $action.outputs }} +| {{ tmpl.Exec "escape_chars" $key }} | {{ if (has $output "description") }}{{ tmpl.Exec "sanatize_string" $output.description }}{{ else }}{{ tmpl.Exec "escape_chars" $key }}{{ end }} | +{{- end }} + +{{- end }} + +{{ if has (ds "config") "include" }} +{{ range $file := (datasource "config").include -}} +{{ (include "includes" $file) }} +{{- end }} +{{- end }} +{{ if has (ds "config") "related" }} +## Related Projects + +Check out these related projects. +{{ range $related := (ds "config").related }} +{{ printf "- [%s](%s) - %s" $related.name $related.url $related.description }}{{ end }} + +{{- end}} +{{- end}} +{{ if has (ds "config") "references" }} + +## References + +For additional context, refer to some of these links. +{{ range $reference := (ds "config").references }} +{{ printf "- [%s](%s) - %s" $reference.name $reference.url $reference.description }}{{ end }} + +{{ end}} +{{- if eq "" $firstNonEmptySection }}{{ template "tip_use_reference_architecture" $context }}{{- end }} + +{{- if eq (ds "config").license "APACHE2" }} +## License + +License + +
+Preamble to the Apache License, Version 2.0 +
+
+ +{{ if (file.Exists "LICENSE") -}} +Complete license is available in the [`LICENSE`](LICENSE) file. +{{- end }} + +```text +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +``` +
+{{- end }} +{{- if eq (ds "config").license "CC-BY-NC-SA-4.0" }} +## License + +Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License + +This material may only be distributed subject to the terms and conditions set forth in the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License or later with the restrictions noted below (the latest version of the license is presently available at ). + +**Attribution** You must attribute the work in the manner specified by the author or licensor. + +**Noncommercial** The licensor permits others to copy, distribute and transmit the work. In return, licensees may not use the work for commercial purposes β€” unless they get the licensor's permission. + +**Share Alike** The licensor permits others to distribute derivative works only under the same license or one compatible with the one that governs the licensor's work. + +## Distribution + +Distribution of substantively modified versions of this document is prohibited without the explicit permission of the copyright holder. + +Distribution of the work or derivative of the work in any standard (paper) book form for commercial purposes is prohibited unless prior permission is obtained from the copyright holder. +{{- end }} + +{{- if eq (ds "config").license "MIT" }} +## License + +License: MIT + +```text +The MIT License (MIT) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + +Source: +``` +{{- end }} + +{{- if eq (ds "config").license "ISC" }} +## License + +License: ISC + +```text +ISC License (ISC) + +Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + +Source: +``` +{{- end }} + +{{- if eq (ds "config").license "GPL3" }} +## License + +License: GPL v3 + +```text +GNU GENERAL PUBLIC LICENSE +Version 3, 29 June 2007 + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +``` +{{- end }} + +## Trademarks + +All other trademarks referenced herein are the property of their respective owners. + +README footer + +Beacon