misc

Author: virgofx

.github/workflows/ci.yml

@@ -11,8 +11,8 @@ on:
       - main
 
 permissions:
-  contents: write
-  pull-requests: write
+  contents: write # Required to create tags, creaste releases and update wiki
+  pull-requests: write # Required to comment on pull requests
 
 jobs:
   test-action:

README.md

@@ -124,7 +124,7 @@ requests and creating releases.
   for `pull-requests` must be set to `"write"`.
 - Additionally, the workflow permission for `contents` must also be set to `"write"` to allow the action to create tags
   and releases.
-- For security considerations and best practices when using the `github_token` or PATs, please refer to the
+- For security considerations and best practices when using the `github_token`, please refer to the
   [Security Documentation](./security.md).
 - Ensure the **Restrict editing to users in teams with push access only** setting is enabled for public repositories, as
   the GitHub Actions Bot can write to the wiki by default.
@@ -190,7 +190,7 @@ by Piotr Krukowski.
 ## Notes
 
 - This action uses [Conventional Commits](https://www.conventionalcommits.org/) to automatically determine the release
-  type _(major, minor, or patch)_ based on commit messages.
+  type _(major, minor, or patch)_ based on commit messages. This behavior is configurable via [inputs](#optional-inputs).
 - Versioning is done using [Semantic Versioning (SemVer)](https://semver.org/), which provides a clear and consistent
   way to manage module versions.
 - Commit messages are linked to the respective Terraform directories _(handling PRs that may have separate modules and

action.yml

@@ -24,10 +24,6 @@ inputs:
     description: Specifies the default tag version. (Should be in format v#.#.#)
     required: true
     default: v1.0.0
-  github_token:
-    description: Use this if you wish to use a different GitHub token than the one provided by the workflow.
-    required: true
-    default: ${{ github.token }}default
   terraform-docs-version:
     description: >
       Specifies the terraform-docs version used to generate documentation for the wiki.
@@ -55,7 +51,12 @@ inputs:
       Adjust this value to control the visibility of changelog entries in the module sidebar.
     required: true
     default: "5"
-
+  github_token:
+    description: |
+      Required for retrieving pull request metadata, tags, releases, updating PR comments, wiki, and creating tags/releases.
+      Automatically injected for convenience; no need to provide a custom token unless you have specific requirements.
+    required: true
+    default: ${{ github.token }}
 runs:
   using: node20
   main: dist/index.js