chore(ci): fix tf-docs on PR (#3144)

* chore(ci) - fix tf-docs on PR

* test

* docs: auto update terraform docs

* enable wokflow on main branch

* review suggestion

Co-authored-by: GuptaNavdeep1983 <[email protected]>

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: GuptaNavdeep1983 <[email protected]>

Author: 3 people

.github/workflows/update-docs.yml

@@ -1,10 +1,10 @@
 name: Update docs
 on:
   push:
-    branches:
-      - release-please--branches--main
-  pull_request:
-
+    paths:
+      - "*.tf"
+      - "*.md"
+      - ".github/workflows/update-docs.yml"
 permissions: read-all
 jobs:
   docs:
@@ -14,12 +14,6 @@ jobs:
     permissions:
       contents: write
     steps:
-      - if: github.event_name == 'pull_request'
-        name: Checkout PR
-        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # ratchet:actions/checkout@v3
-        with:
-          ref: ${{ github.event.pull_request.head.ref }}
-
       - if: github.event_name == 'push'
         name: Checkout branch
         uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # ratchet:actions/checkout@v3
@@ -29,4 +23,14 @@ jobs:
         with:
           find-dir: .
           git-commit-message: "docs: auto update terraform docs"
-          git-push: true
+          git-push: ${{ github.ref != 'refs/heads/main' }}
+
+      - name: Create Pull Request (main branch only)
+        if: github.ref == 'refs/heads/main'
+        uses: peter-evans/create-pull-request@38e0b6e68b4c852a5500a94740f0e535e0d7ba54 # ratchet:peter-evans/[email protected]
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: "Update Terraform docs"
+          title: "docs: Update Terraform docs"
+          branch: ${{ github.event.pull_request.base.ref }}-update-docs
+          base: ${{ github.event.pull_request.base.ref }}

CONTRIBUTING.md

@@ -51,9 +51,9 @@ If your issue appears to be a bug, and hasn't been reported, open a new issue. H
 
 **If you get help, help others. Good karma rulez!**
 
-### Submitting a Merge Request
+### Submitting a Pull Request
 
-Before you submit your merge request consider the following guidelines:
+Before you submit your pull request consider the following guidelines:
 
 * Make your changes in a new git branch:
 
@@ -62,8 +62,9 @@ Before you submit your merge request consider the following guidelines:
     ```
 
 * Create your patch, **including appropriate test cases**.
-* Install [Terraform](https://www.terraform.io/). We lock the version with [tvenv](https://github.com/tfutils/tfenv), check `required_version` in `versions.tf` for the current development version of the module.
-* Install [pre-commit hooks](https://pre-commit.com/). The hooks runs some basic checks and update the docs. The commit will run the hooks, you can invoke the hooks manually `pre-commit run --all-files` as well.
+* Install [Terraform](https://www.terraform.io/). We lock the version with [tfenv](https://github.com/tfutils/tfenv), check `required_version` in `versions.tf` for the current development version of the module.
+* Install [pre-commit hooks](https://pre-commit.com/). The hooks runs some basic checks. The commit will run the hooks, you can invoke the hooks manually `pre-commit run --all-files` as well.
+* For updating docs, you have to enable GitHub actions on your forked repository. Simply go to the tab Actions and enable actions.
 * Commit your changes using a descriptive commit message.
 
     ```shell

README.md

@@ -36,6 +36,12 @@ This [Terraform](https://www.terraform.io/) module creates the required infrastr
 - [Logging](#logging)
 - [Debugging](#debugging)
 - [Security Consideration](#security-consideration)
+- [Requirements](#requirements)
+- [Providers](#providers)
+- [Modules](#modules)
+- [Resources](#resources)
+- [Inputs](#inputs)
+- [Outputs](#outputs)
 - [Contribution](#contribution)
 - [Philips Forest](#philips-forest)