From ceebb781ca443aeeccbbb15b3f359a78ad2ef4ce Mon Sep 17 00:00:00 2001 From: Khosrow Moossavi Date: Tue, 17 Sep 2024 20:15:41 -0400 Subject: [PATCH] chore: update README Signed-off-by: Khosrow Moossavi --- .github/templates/README.tpl | 3 ++- README.md | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/templates/README.tpl b/.github/templates/README.tpl index 8048a19..fe8f336 100644 --- a/.github/templates/README.tpl +++ b/.github/templates/README.tpl @@ -6,7 +6,8 @@ {{- $tfdocsversion := or (getenv "TERRAFORM_DOCS_VERSION") "v0.0.0" -}} # terraform-docs GitHub Actions -{{ $action.description }} +{{ $action.description }}. + In addition to statically defined directory modules, this module can search specific subfolders or parse `atlantis.yaml` for module identification and doc generation. This action has the ability to auto commit docs to an open PR or after a push to a specific diff --git a/README.md b/README.md index 34e8fb2..ee9c72c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # terraform-docs GitHub Actions -A Github action for generating Terraform module documentation using terraform-docs and gomplate. +Generate Terraform module documentation in pull requests. + In addition to statically defined directory modules, this module can search specific subfolders or parse `atlantis.yaml` for module identification and doc generation. This action has the ability to auto commit docs to an open PR or after a push to a specific