diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml deleted file mode 100644 index 3945246..0000000 --- a/.pre-commit-config.yaml +++ /dev/null @@ -1,7 +0,0 @@ -# Prerequisites: -# brew install pre-commit terraform-docs -repos: - - repo: https://github.com/antonbabenko/pre-commit-terraform - rev: v1.88.0 - hooks: - - id: terraform_docs diff --git a/.terraform-docs.yaml b/.terraform-docs.yaml new file mode 100644 index 0000000..160872e --- /dev/null +++ b/.terraform-docs.yaml @@ -0,0 +1,17 @@ +version: 0.19.0 +formatter: markdown table + +recursive: + enabled: true + include-main: false + +settings: + lockfile: false + +output: + file: README.md + mode: inject + template: |- + + {{ .Content }} + diff --git a/.trunk/trunk.yaml b/.trunk/trunk.yaml index 0b14980..3bae143 100644 --- a/.trunk/trunk.yaml +++ b/.trunk/trunk.yaml @@ -40,6 +40,7 @@ lint: - CHANGELOG.md actions: enabled: + - terraform-docs - trunk-announce - trunk-check-pre-push - trunk-fmt-pre-commit diff --git a/README.md b/README.md index 865dbf2..c34bf48 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,90 @@ +[![Banner][banner-image]](https://masterpoint.io/) + # terraform-module-template -[![Release](https://img.shields.io/github/release/masterpointio/terraform-module-template.svg)](https://github.com/masterpointio/terraform-module-template/releases/latest) +[![Release][release-badge]][latest-release] + +πŸ’‘ Learn more about Masterpoint [below](#who-we-are-𐦂𖨆π€ͺπ– ‹). + +## Purpose and Functionality -This repository serves as a template for creating Terraform modules, providing a standardized structure and essential files for efficient module development. It's designed to ensure consistency and best practices across Terraform projects. +This repository serves as a template for creating Terraform modules, providing a standardized structure and essential files for efficient module development. It's designed to ensure consistency and our best practices across Terraform projects. ## Usage +### Prerequisites (optional) + +TODO + +### Step-by-Step Instructions + TODO + -## Requirements +## Built By -No requirements. +Powered by the [Masterpoint team](https://masterpoint.io/who-we-are/) and driven forward by contributions from the community ❀️ -## Providers +[![Contributors][contributors-image]][contributors-url] -No provider. +## Contribution Guidelines -## Inputs +Contributions are welcome and appreciated! -No input. +Found an issue or want to request a feature? [Open an issue][issues-url] -## Outputs +Want to fix a bug you found or add some functionality? Fork, clone, commit, push, and PR β€” we'll check it out. -No output. +## Who We Are 𐦂𖨆π€ͺπ– ‹ - +Established in 2016, Masterpoint is a team of experienced software and platform engineers specializing in Infrastructure as Code (IaC). We provide expert guidance to organizations of all sizes, helping them leverage the latest IaC practices to accelerate their engineering teams. -## Contributing +### Our Mission -Contributions are welcome and appreciated! +Our mission is to simplify cloud infrastructure so developers can innovate faster, safer, and with greater confidence. By open-sourcing tools and modules that we use internally, we aim to contribute back to the community, promoting consistency, quality, and security. -Found an issue or want to request a feature? [Open an issue](TODO) +### Our Commitments -Want to fix a bug you found or add some functionality? Fork, clone, commit, push, and PR and we'll check it out. +- 🌟 **Open Source**: We live and breathe open source, contributing to and maintaining hundreds of projects across multiple organizations. +- 🌎 **1% for the Planet**: Demonstrating our commitment to environmental sustainability, we are proud members of [1% for the Planet](https://www.onepercentfortheplanet.org), pledging to donate 1% of our annual sales to environmental nonprofits. +- πŸ‡ΊπŸ‡¦ **1% Towards Ukraine**: With team members and friends affected by the ongoing [Russo-Ukrainian war](https://en.wikipedia.org/wiki/Russo-Ukrainian_War), we donate 1% of our annual revenue to invasion relief efforts, supporting organizations providing aid to those in need. [Here's how you can help Ukraine with just a few clicks](https://masterpoint.io/updates/supporting-ukraine/). -If you have any issues or are waiting a long time for a PR to get merged then feel free to ping us at [hello@masterpoint.io](mailto:hello@masterpoint.io). +## Connect With Us -## Built By +We're active members of the community and are always publishing content, giving talks, and sharing our hard earned expertise. Here are a few ways you can see what we're up to: + +[![LinkedIn][linkedin-badge]][linkedin-url] [![Newsletter][newsletter-badge]][newsletter-url] [![Blog][blog-badge]][blog-url] [![YouTube][youtube-badge]][youtube-url] + +... and be sure to connect with our founder, [Matt Gowie](https://www.linkedin.com/in/gowiem/). + +## License + +[Apache License, Version 2.0][license-url]. + +[![Open Source Initiative][osi-image]][license-url] + +Copyright Β© 2016-2025 [Masterpoint Consulting LLC](https://masterpoint.io/) + + + +[banner-image]: https://masterpoint-public.s3.us-west-2.amazonaws.com/v2/standard-long-fullcolor.png +[license-url]: https://opensource.org/license/apache-2-0 +[osi-image]: https://i0.wp.com/opensource.org/wp-content/uploads/2023/03/cropped-OSI-horizontal-large.png?fit=250%2C229&ssl=1 +[linkedin-badge]: https://img.shields.io/badge/LinkedIn-Follow-0A66C2?style=for-the-badge&logoColor=white +[linkedin-url]: https://www.linkedin.com/company/masterpoint-consulting +[blog-badge]: https://img.shields.io/badge/Blog-IaC_Insights-55C1B4?style=for-the-badge&logoColor=white +[blog-url]: https://masterpoint.io/updates/ +[newsletter-badge]: https://img.shields.io/badge/Newsletter-Subscribe-ECE295?style=for-the-badge&logoColor=222222 +[newsletter-url]: https://newsletter.masterpoint.io/ +[youtube-badge]: https://img.shields.io/badge/YouTube-Subscribe-D191BF?style=for-the-badge&logo=youtube&logoColor=white +[youtube-url]: https://www.youtube.com/channel/UCeeDaO2NREVlPy9Plqx-9JQ + + -[![Masterpoint Logo](https://i.imgur.com/RDLnuQO.png)](https://masterpoint.io) +[release-badge]: https://img.shields.io/github/v/release/masterpointio/terraform-module-template?color=0E383A&label=Release&style=for-the-badge&logo=github&logoColor=white +[latest-release]: https://github.com/masterpointio/terraform-module-template/releases/latest +[contributors-image]: https://contrib.rocks/image?repo=masterpointio/terraform-module-template +[contributors-url]: https://github.com/masterpointio/terraform-module-template/graphs/contributors +[issues-url]: https://github.com/masterpointio/terraform-module-template/issues diff --git a/aqua.yaml b/aqua.yaml index 800bfdd..ecf29f3 100644 --- a/aqua.yaml +++ b/aqua.yaml @@ -10,6 +10,6 @@ registries: - type: standard ref: v4.210.0 # renovate: depName=aquaproj/aqua-registry packages: - - name: terraform-docs/terraform-docs@v0.18.0 + - name: terraform-docs/terraform-docs@v0.19.0 - name: hashicorp/terraform@v1.9.3 - name: opentofu/opentofu@v1.8.0