github-action-readme-generator 1.8.3 → 1.8.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +7 -3
  3. package/action.yml +1 -7
  4. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,3 +1,17 @@
1
+ ## [1.8.5](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.8.4...v1.8.5) (2025-12-07)
2
+
3
+
4
+ ### Bug Fixes
5
+
6
+ * **deps:** update github action versions ([#420](https://github.com/bitflight-devops/github-action-readme-generator/issues/420)) ([f1bdab5](https://github.com/bitflight-devops/github-action-readme-generator/commit/f1bdab5dbb31ec83bd0f2c92e23f8079798e8fab))
7
+
8
+ ## [1.8.4](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.8.3...v1.8.4) (2025-11-21)
9
+
10
+
11
+ ### Bug Fixes
12
+
13
+ * add 📓 emoji to description and adjust wording to stay under 125 chars ([abd2cad](https://github.com/bitflight-devops/github-action-readme-generator/commit/abd2cadce1dda79f7c480e762bec367e7e3e5b0a))
14
+
1
15
  ## [1.8.3](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.8.2...v1.8.3) (2025-11-21)
2
16
 
3
17
 
package/README.md CHANGED
@@ -14,11 +14,15 @@
14
14
  </div>
15
15
  <!-- start description -->
16
16
 
17
+ 📓 Effortlessly sync action.yml to README.md. Auto-generates inputs, outputs & usage docs, ensuring docs match code.
18
+
19
+ <!-- end description -->
20
+
17
21
  📓 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.
22
+
18
23
  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.
19
- **_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.\*\*\*
20
24
 
21
- <!-- end description -->
25
+ **_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.\*\*\*
22
26
 
23
27
  ## CLI Usage
24
28
 
@@ -123,7 +127,7 @@ This configuration will automatically regenerate your README whenever `action.ym
123
127
  <!-- start usage -->
124
128
 
125
129
  ```yaml
126
- - uses: bitflight-devops/github-action-readme-generator@v1.8.2
130
+ - uses: bitflight-devops/github-action-readme-generator@v1.8.4
127
131
  with:
128
132
  # Description: The absolute or relative path to the `action.yml` file to read in
129
133
  # from.
package/action.yml CHANGED
@@ -1,13 +1,7 @@
1
1
  ---
2
2
  name: GitHub Action's Readme Generator
3
3
  author: Jamie Nelson <jamie@bitflight.io>
4
- description: >+
5
- 📓 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.
6
-
7
- 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.
8
-
9
- ***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.
10
- You can find an example README template with all fields filled-in in the [`README.example.md`](./README.example.md) file.***
4
+ description: 📓 Effortlessly sync action.yml to README.md. Auto-generates inputs, outputs & usage docs, ensuring docs match code.
11
5
 
12
6
  branding:
13
7
  icon: book-open
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "github-action-readme-generator",
3
3
  "displayName": "bitflight-devops/github-action-readme-generator",
4
- "version": "1.8.3",
4
+ "version": "1.8.5",
5
5
  "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.",
6
6
  "keywords": [
7
7
  "actions",