github-action-readme-generator 1.8.2 → 1.8.4

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [1.8.4](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.8.3...v1.8.4) (2025-11-21)
+
+
+### Bug Fixes
+
+* add 📓 emoji to description and adjust wording to stay under 125 chars ([abd2cad](https://github.com/bitflight-devops/github-action-readme-generator/commit/abd2cadce1dda79f7c480e762bec367e7e3e5b0a))
+
+## [1.8.3](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.8.2...v1.8.3) (2025-11-21)
+
+
+### Bug Fixes
+
+* **release:** update package.json ([489cdf9](https://github.com/bitflight-devops/github-action-readme-generator/commit/489cdf9287705c014e3fa04b060e9d235ae60a1c))
+
 ## [1.8.2](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.8.1...v1.8.2) (2025-11-21)
 
 

package/README.md

@@ -14,11 +14,15 @@
 </div>
 <!-- start description -->
 
+📓 Effortlessly sync action.yml to README.md. Auto-generates inputs, outputs & usage docs, ensuring docs match code.
+
+<!-- end description -->
+
 📓 Keep your action's README.md up to date with the `title` and `description` from the [`action.yml`](./action.yml) file, while also automatically generating sections for the inputs, outputs, and a usage example for the action. Additionally the Action's usage example is updated to match the Action's current release.
+
 This is both a CLI tool and GitHub Action that will read the details from a GitHub Action's [`action.yml`](./action.yml) file. Configuration can be provided through a [`.ghadocs.json`](./.ghadocs.json) file stored in the root directory of the Action's repository, via the command line when using the CLI, or through the `with:` section of this Action.
-**_HOW_** 📝 This tool uses markdown comments like this `<!-- start section --><!-- stop section -->` as delimiting tokens within your README.md file to determine where to place the generated content. You can find an example README template with all fields filled-in in the [`README.example.md`](./README.example.md) file.\*\*\*
 
-<!-- end description -->
+**_HOW_** 📝 This tool uses markdown comments like this `<!-- start section --><!-- stop section -->` as delimiting tokens within your README.md file to determine where to place the generated content. You can find an example README template with all fields filled-in in the [`README.example.md`](./README.example.md) file.\*\*\*
 
 ## CLI Usage
 
@@ -123,7 +127,7 @@ This configuration will automatically regenerate your README whenever `action.ym
 <!-- start usage -->
 
 ```yaml
-- uses: bitflight-devops/github-action-readme-generator@v1.8.1
+- uses: bitflight-devops/github-action-readme-generator@v1.8.3
   with:
     # Description: The absolute or relative path to the `action.yml` file to read in
     # from.

package/action.yml

@@ -1,13 +1,7 @@
 ---
 name: GitHub Action's Readme Generator
 author: Jamie Nelson <jamie@bitflight.io>
-description: >+
-  📓 Keep your action's README.md up to date with the `title` and `description` from the [`action.yml`](./action.yml) file, while also automatically generating sections for the inputs, outputs, and a usage example for the action. Additionally the Action's usage example is updated to match the Action's current release.
-
-  This is both a CLI tool and GitHub Action that will read the details from a GitHub Action's [`action.yml`](./action.yml) file. Configuration can be provided through a [`.ghadocs.json`](./.ghadocs.json) file stored in the root directory of the Action's repository, via the command line when using the CLI, or through the `with:` section of this Action.
-
-  ***HOW*** 📝 This tool uses markdown comments like this `<!-- start section --><!-- stop section -->` as delimiting tokens within your README.md file to determine where to place the generated content.
-  You can find an example README template with all fields filled-in in the [`README.example.md`](./README.example.md) file.***
+description: 📓 Effortlessly sync action.yml to README.md. Auto-generates inputs, outputs & usage docs, ensuring docs match code.
 
 branding:
   icon: book-open

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "github-action-readme-generator",
   "displayName": "bitflight-devops/github-action-readme-generator",
-  "version": "1.8.2",
+  "version": "1.8.4",
   "description": "This is a CLI tool and GitHub Action that reads in the details from a \nGitHub Action's `action.yml` file and updates the `README.md` file\nwith the `name`, `description`, `usage`, `inputs`, `outputs`, and\nexamples of the action.\nConfiguration can be provided via a `.ghadocs.json` file stored in the\nroot directory of the Action's repository, via the command line when\nusing the cli, or via the `with:` section of this Action.\n\n\nThis tool uses markdown comments as delimiting tokens within the `README.md`\nfile to determine where to place the generated content.\n\n[`README.example.md`](README.example.md) example with all fields filled in, and no other free-form content.",
   "keywords": [
     "actions",
@@ -134,17 +134,7 @@
           "provenance": true
         }
       ],
-      [
-        "@semantic-release/github",
-        {
-          "assets": [
-            "dist/**",
-            "action.yml",
-            "package.json",
-            "package-lock.json"
-          ]
-        }
-      ],
+      "@semantic-release/github",
       "@semantic-release/git"
     ],
     "preset": "angular"