From b1dee51904e1a98b5e9e8efec216c7047b475bd5 Mon Sep 17 00:00:00 2001 From: Timothy MacDonald Date: Thu, 5 Oct 2023 09:49:28 -0500 Subject: [PATCH 1/2] docs(readme): add terraform docs automation Add terraform docs script along with makefile target and gihub action for same Signed-off-by: Timothy MacDonald --- .github/.workflows/terraform_docs.yml | 18 ++++++++++++++++++ .terraform-docs.yml | 4 ++++ GNUmakefile | 5 +++++ README.md | 5 +++-- scripts/terraform-docs.sh | 13 +++++++++++++ 5 files changed, 43 insertions(+), 2 deletions(-) create mode 100644 .github/.workflows/terraform_docs.yml create mode 100644 .terraform-docs.yml create mode 100755 scripts/terraform-docs.sh diff --git a/.github/.workflows/terraform_docs.yml b/.github/.workflows/terraform_docs.yml new file mode 100644 index 0000000..2ec2082 --- /dev/null +++ b/.github/.workflows/terraform_docs.yml @@ -0,0 +1,18 @@ +name: Generate terraform docs +on: + - pull_request +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + ref: ${{ github.event.pull_request.head.ref }} + + - name: Render terraform docs inside the README.md and push changes back to PR branch + uses: terraform-docs/gh-actions@v1.0.0 + with: + working-dir: . + output-file: README.md + output-method: inject + git-push: "true" \ No newline at end of file diff --git a/.terraform-docs.yml b/.terraform-docs.yml new file mode 100644 index 0000000..f46384b --- /dev/null +++ b/.terraform-docs.yml @@ -0,0 +1,4 @@ +formatter: "markdown" +version: "0.16.0" +output: + file: README.md diff --git a/GNUmakefile b/GNUmakefile index 616c4f2..2ecf2b4 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -15,3 +15,8 @@ ci: ## *CI ONLY* Runs tests on CI pipeline .PHONY: release release: ci ## *CI ONLY* Prepares a release of the Terraform module scripts/release.sh prepare + +.PHONY: terraform-docs +terraform-docs: + scripts/terraform-docs.sh + diff --git a/README.md b/README.md index dd6a436..13ddfbe 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ storage-component.googleapis.com cloudasset.googleapis.com essentialcontacts.googleapis.com ``` - + ## Requirements | Name | Version | @@ -111,7 +111,7 @@ essentialcontacts.googleapis.com | [required\_config\_apis](#input\_required\_config\_apis) | n/a | `map(any)` | 
{
  "bigquery": "bigquery.googleapis.com",
  "cloudasset_inventory": "cloudasset.googleapis.com",
  "compute": "compute.googleapis.com",
  "containers": "container.googleapis.com",
  "dns": "dns.googleapis.com",
  "essentialcontacts": "essentialcontacts.googleapis.com",
  "iam": "iam.googleapis.com",
  "kms": "cloudkms.googleapis.com",
  "logging": "logging.googleapis.com",
  "pubsub": "pubsub.googleapis.com",
  "resourcemanager": "cloudresourcemanager.googleapis.com",
  "serviceusage": "serviceusage.googleapis.com",
  "sqladmin": "sqladmin.googleapis.com",
  "storage_component": "storage-component.googleapis.com"
}
| no | | [service\_account\_name](#input\_service\_account\_name) | The Service Account name (required when use\_existing\_service\_account is set to true). This can also be used to specify the new service account name when use\_existing\_service\_account is set to false | `string` | `""` | no | | [service\_account\_private\_key](#input\_service\_account\_private\_key) | The private key in JSON format, base64 encoded (required when use\_existing\_service\_account is set to true) | `string` | `""` | no | -| [skip\_iam\_grants](#input\_skip\_iam\_grants) | Skip generation of custom role, and IAM grants to the Service Account, for customers who use IAM policy-as-code external to the Lacework module. WARNING - integration will fail if grants are not in place prior to execution. 'use_existing_service_account' must also be set to `true` | `bool` | `false` | no | +| [skip\_iam\_grants](#input\_skip\_iam\_grants) | Skip generation of custom role, and IAM grants to the Service Account, for customers who use IAM policy-as-code external to the Lacework module. WARNING - integration will fail if grants are not in place prior to execution. 'use\_existing\_service\_account' must also be set to `true` | `bool` | `false` | no | | [use\_existing\_service\_account](#input\_use\_existing\_service\_account) | Set this to true to use an existing Service Account | `bool` | `false` | no | | [wait\_time](#input\_wait\_time) | Amount of time to wait before the next resource is provisioned | `string` | `"10s"` | no | @@ -121,3 +121,4 @@ essentialcontacts.googleapis.com |------|-------------| | [service\_account\_name](#output\_service\_account\_name) | The Service Account name | | [service\_account\_private\_key](#output\_service\_account\_private\_key) | The private key in JSON format, base64 encoded | + \ No newline at end of file diff --git a/scripts/terraform-docs.sh b/scripts/terraform-docs.sh new file mode 100755 index 0000000..96e4f65 --- /dev/null +++ b/scripts/terraform-docs.sh @@ -0,0 +1,13 @@ + +if which terraform-docs >/dev/null; then + terraform-docs . +elif which docker >/dev/null; then + echo "## terraform-docs not found in PATH, but docker was found" + echo "## running terraform-docs in docker" + terraform_docs_version=$(cat .terraform-docs.yml | grep version | cut -d\" -f 2) + docker run --rm -v `pwd`:/data cytopia/terraform-docs:${terraform_docs_version} terraform-docs . +else + echo "## terraform-docs not found in PATH, neither was docker" + echo "## please install terraform-docs or docker" + exit 1 +fi \ No newline at end of file From 95dcf3f86c3549f325dc3103bdfc6af41164c1a4 Mon Sep 17 00:00:00 2001 From: Timothy MacDonald Date: Mon, 9 Oct 2023 14:25:05 -0500 Subject: [PATCH 2/2] docs(readme): automate update and testing of README.md by terraform-docs Add github action to test that README.md has been update. Also add update of README.md to /scripts/release.sh prepare Signed-off-by: Timothy MacDonald --- .github/.workflows/terraform_docs.yml | 18 ----------------- .github/workflows/terraform_docs.yml | 29 +++++++++++++++++++++++++++ scripts/release_helpers.sh | 7 ++++++- 3 files changed, 35 insertions(+), 19 deletions(-) delete mode 100644 .github/.workflows/terraform_docs.yml create mode 100644 .github/workflows/terraform_docs.yml diff --git a/.github/.workflows/terraform_docs.yml b/.github/.workflows/terraform_docs.yml deleted file mode 100644 index 2ec2082..0000000 --- a/.github/.workflows/terraform_docs.yml +++ /dev/null @@ -1,18 +0,0 @@ -name: Generate terraform docs -on: - - pull_request -jobs: - docs: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - with: - ref: ${{ github.event.pull_request.head.ref }} - - - name: Render terraform docs inside the README.md and push changes back to PR branch - uses: terraform-docs/gh-actions@v1.0.0 - with: - working-dir: . - output-file: README.md - output-method: inject - git-push: "true" \ No newline at end of file diff --git a/.github/workflows/terraform_docs.yml b/.github/workflows/terraform_docs.yml new file mode 100644 index 0000000..276d534 --- /dev/null +++ b/.github/workflows/terraform_docs.yml @@ -0,0 +1,29 @@ +name: Test that terraform docs has been run +on: push +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + ref: ${{ github.event.pull_request.head.ref }} + - name: Install terraform-docs + run: curl -L https://github.com/terraform-docs/terraform-docs/releases/download/v0.16.0/terraform-docs-v0.16.0-linux-amd64.tar.gz | (cd /usr/local/bin; tar zxvf -; chmod +x /usr/local/bin/terraform-docs) + - name: store hash of orig README.md + id: old_hash + run: echo "README_HASH=$(md5sum README.md)" >> $GITHUB_OUTPUT + - name: Update README.md using terraform-docs make target + run: make terraform-docs + - name: store hash of new README.md + id: new_hash + run: echo "README_HASH=$(md5sum README.md)" >> $GITHUB_OUTPUT + - name: echo hashes + run: | + echo ${{ steps.old_hash.outputs.README_HASH }} + echo ${{ steps.new_hash.outputs.README_HASH }} + - name: test to see of hashs are the same + if: ${{ steps.old_hash.outputs.README_HASH != steps.new_hash.outputs.README_HASH }} + uses: actions/github-script@v6 + with: + script: | + core.setFailed('Please run "make terraform-docs" and try again') \ No newline at end of file diff --git a/scripts/release_helpers.sh b/scripts/release_helpers.sh index d9a8235..3106297 100644 --- a/scripts/release_helpers.sh +++ b/scripts/release_helpers.sh @@ -1,6 +1,6 @@ # # Name:: release_helpers.sh -# Description:: A set of helper funtions to be used by our release.sh script +# Description:: A set of helper functions to be used by our release.sh script # Author:: Salim Afiune Maya () # @@ -137,6 +137,7 @@ prepare_release() { prerequisites remove_tag_version check_for_minor_version_bump + generate_readme generate_release_notes update_changelog push_release @@ -192,6 +193,10 @@ generate_release_notes() { echo "$(cat CHANGES.md)" >> RELEASE_NOTES.md } +generate_readme() { + make terraform-docs +} + load_list_of_changes() { latest_version=$(find_latest_version) local _list_of_changes=$(git log --no-merges --pretty="* %s (%an)([%h](https://github.com/${org_name}/${project_name}/commit/%H))" ${latest_version}..${main_branch})