fix(github-actions): terraform docs commit message

[venkatamutyala]

Type

enhancement

---

Description

• Updated the GitHub Actions workflow for Terraform documentation to use a specific version (v1.1.0) of terraform-docs/gh-actions.
• Introduced a custom commit message ("docs: automated update of terraform docs") for commits made by the automated documentation update process.

---

Changes walkthrough

	Relevant files
Enhancement	docs.yml Update Terraform Docs GitHub Action and Customize Commit Message .github/workflows/docs.yml Updated the terraform-docs/gh-actions to version v1.1.0. Added a custom commit message for the automated terraform docs update. +2/-1

---

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[qodo-merge-pro]

PR Description updated to latest commit (f51ac38)

• Copy walkthrough table to "Files Changed" Tab

[qodo-merge-pro]

PR Review

⏱️ Estimated effort to review [1-5]	1, because the PR involves a straightforward update to a GitHub Actions workflow file. The changes are minimal and focused on specifying a version for a GitHub Action and adding a custom commit message for automated documentation updates.
🧪 Relevant tests	No
🔍 Possible issues	No
🔒 Security concerns	No

---

✨ Review tool usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.

• When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

• With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

See the review usage page for a comprehensive guide on using this tool.

[qodo-merge-pro]

PR Code Suggestions

Category	Suggestions
Best practice	Pin the GitHub Action to a specific commit SHA for enhanced security and reliability. Consider pinning the terraform-docs/gh-actions to a specific commit SHA rather than a version tag like v1.1.0. Using a commit SHA is a best practice for GitHub Actions to ensure the action does not change unexpectedly if the tag is moved or altered, enhancing the security and reliability of your CI/CD pipeline. .github/workflows/docs.yml [14] -uses: terraform-docs/[email protected] +uses: terraform-docs/gh-actions@[COMMIT_SHA]
Enhancement	Adjust the automated commit message to align with project conventions. Ensure that the git-commit-message for automated terraform docs updates is clear and follows your project's commit message conventions. The current message "docs: automated update of terraform docs" is clear, but if your project uses a different convention for automated or documentation-related commits, consider adjusting it accordingly. .github/workflows/docs.yml [20] -git-commit-message: "docs: automated update of terraform docs" +git-commit-message: "chore(docs): update terraform documentation"

---

✨ Improve tool usage guide:

---

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

• When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

• With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

See the improve usage page for a comprehensive guide on using this tool.