github-action-readme-generator 1.10.0 → 1.10.2
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.
- package/CHANGELOG.md +15 -0
- package/README.md +23 -23
- package/dist/bin/index.js +13796 -8652
- package/dist/mjs/helpers.d.ts +5 -3
- package/dist/mjs/helpers.js +4 -4
- package/dist/mjs/helpers.js.map +1 -1
- package/dist/mjs/inputs.d.ts +3 -1
- package/dist/mjs/inputs.js +2 -1
- package/dist/mjs/inputs.js.map +1 -1
- package/dist/types/index.d.ts +7 -4
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,18 @@
|
|
|
1
|
+
## [1.10.2](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.10.1...v1.10.2) (2026-02-11)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* initial plan for @actions/github v9 compatibility ([808b3a3](https://github.com/bitflight-devops/github-action-readme-generator/commit/808b3a370ecb1da8a1146384eb7b34630bac7374))
|
|
7
|
+
* update @actions/github imports for v9.0.0 compatibility ([1e71bf4](https://github.com/bitflight-devops/github-action-readme-generator/commit/1e71bf4153366109c0962bb44c289542031fe30c))
|
|
8
|
+
|
|
9
|
+
## [1.10.1](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.10.0...v1.10.1) (2026-02-04)
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
### Bug Fixes
|
|
13
|
+
|
|
14
|
+
* restore bold formatting in table first column ([c07a40d](https://github.com/bitflight-devops/github-action-readme-generator/commit/c07a40dd260c98b37df4d5b180c80eac3289e344))
|
|
15
|
+
|
|
1
16
|
# [1.10.0](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.9.3...v1.10.0) (2026-02-04)
|
|
2
17
|
|
|
3
18
|
|
package/README.md
CHANGED
|
@@ -288,33 +288,33 @@ This configuration will automatically regenerate your README whenever `action.ym
|
|
|
288
288
|
|
|
289
289
|
<!-- start inputs -->
|
|
290
290
|
|
|
291
|
-
| **Input**
|
|
292
|
-
|
|
|
293
|
-
| <code>action</code> | The absolute or relative path to the <code>action.yml</code> file to read in from. | <code>action.yml</code> | **false** |
|
|
294
|
-
| <code>readme</code> | The absolute or relative path to the markdown output file that contains the formatting tokens within it. | <code>README.md</code> | **false** |
|
|
295
|
-
| <code>owner</code> | The GitHub Action repository owner, this field is autodetected by default.<br />Example: <code>bitflight-devops</code> or <code>your-gh-username</code> | | **false** |
|
|
296
|
-
| <code>repo</code> | The GitHub Action repository name, this field is autodetected by default.<br />Example: <code>github-action-readme-generator</code> | | **false** |
|
|
297
|
-
| <code>save</code> | Save the provided values in a <code>.ghadocs.json</code> file.<br />This will update any existing <code>.ghadocs.json</code> file that is in place. | | **false** |
|
|
298
|
-
| <code>pretty</code> | Use <code>prettier</code> to pretty print the new README.md file | <code>true</code> | **false** |
|
|
299
|
-
| <code>versioning_enabled</code> | Enable the update of the usage version to match the latest version in the <code>package.json</code> file<br />Output if your action repo is <code>reviewdog/action-eslint</code> and version in package.json is <code>1.0.1</code>:<br /><code>uses: reviewdog/action-eslint@1.0.1</code> | <code>true</code> | **false** |
|
|
300
|
-
| <code>version_override</code> | Set a specific version to display in the README.md, maybe you want to use a major or minor version | | **false** |
|
|
301
|
-
| <code>version_prefix</code> | Prefix the version with this value, if it isn't already prefixed | <code>v</code> | **false** |
|
|
302
|
-
| <code>versioning_default_branch</code> | If versioning is disabled, use this branch in the usage example, where the default is <code>main</code><br />Output if your action repo is <code>reviewdog/action-eslint</code>:<br /><code>uses: reviewdog/action-eslint@main</code> | <code>main</code> | **false** |
|
|
303
|
-
| <code>version_source</code> | How to detect the action version for the usage example.<br />Options:<br />- <code>git-tag</code> - Latest git tag (default, standard for GitHub Actions)<br />- <code>git-branch</code> - Current branch name (for bleeding edge users)<br />- <code>git-sha</code> - Current commit SHA (for exact pinning)<br />- <code>package-json</code> - Read from package.json version field<br />- <code>explicit</code> - Use value from <code>version_override</code> input only | <code>git-tag</code> | **false** |
|
|
304
|
-
| <code>title_prefix</code> | Add a prefix to the README title.<br />The title template looks like this:<br /># {brand}{prefix}{title} | <code>GitHub Action: </code> | **false** |
|
|
305
|
-
| <code>include_github_version_badge</code> | Include additional badge showing latest tag | <code>true</code> | **false** |
|
|
306
|
-
| <code>branding_svg_path</code> | Create the branding svg image from the branding object in <code>action.yml</code><br />then save it to this path.<br />Then update the <code>README.md</code> file to source the branding image from this path.<br />You can use a section template like this:<br /><code>\<!-- start branding -->\<!-- stop branding --></code><br />or use the action input:<br /><code>branding_as_title_prefix: true</code><br />to prefix the 'title' section with the image.<br />The title template looks like this:<br /># {brand}{prefix}{title} | <code>.github/ghadocs/branding.svg</code> | **false** |
|
|
307
|
-
| <code>branding_as_title_prefix</code> | Prefix the title in the <code>\<!-- start title --></code> section with the svg branding image<br />The title template looks like this:<br /># {brand}{prefix}{title} | <code>true</code> | **false** |
|
|
291
|
+
| **Input** | **Description** | **Default** | **Required** |
|
|
292
|
+
| ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | ------------ |
|
|
293
|
+
| <b><code>action</code></b> | The absolute or relative path to the <code>action.yml</code> file to read in from. | <code>action.yml</code> | **false** |
|
|
294
|
+
| <b><code>readme</code></b> | The absolute or relative path to the markdown output file that contains the formatting tokens within it. | <code>README.md</code> | **false** |
|
|
295
|
+
| <b><code>owner</code></b> | The GitHub Action repository owner, this field is autodetected by default.<br />Example: <code>bitflight-devops</code> or <code>your-gh-username</code> | | **false** |
|
|
296
|
+
| <b><code>repo</code></b> | The GitHub Action repository name, this field is autodetected by default.<br />Example: <code>github-action-readme-generator</code> | | **false** |
|
|
297
|
+
| <b><code>save</code></b> | Save the provided values in a <code>.ghadocs.json</code> file.<br />This will update any existing <code>.ghadocs.json</code> file that is in place. | | **false** |
|
|
298
|
+
| <b><code>pretty</code></b> | Use <code>prettier</code> to pretty print the new README.md file | <code>true</code> | **false** |
|
|
299
|
+
| <b><code>versioning_enabled</code></b> | Enable the update of the usage version to match the latest version in the <code>package.json</code> file<br />Output if your action repo is <code>reviewdog/action-eslint</code> and version in package.json is <code>1.0.1</code>:<br /><code>uses: reviewdog/action-eslint@1.0.1</code> | <code>true</code> | **false** |
|
|
300
|
+
| <b><code>version_override</code></b> | Set a specific version to display in the README.md, maybe you want to use a major or minor version | | **false** |
|
|
301
|
+
| <b><code>version_prefix</code></b> | Prefix the version with this value, if it isn't already prefixed | <code>v</code> | **false** |
|
|
302
|
+
| <b><code>versioning_default_branch</code></b> | If versioning is disabled, use this branch in the usage example, where the default is <code>main</code><br />Output if your action repo is <code>reviewdog/action-eslint</code>:<br /><code>uses: reviewdog/action-eslint@main</code> | <code>main</code> | **false** |
|
|
303
|
+
| <b><code>version_source</code></b> | How to detect the action version for the usage example.<br />Options:<br />- <code>git-tag</code> - Latest git tag (default, standard for GitHub Actions)<br />- <code>git-branch</code> - Current branch name (for bleeding edge users)<br />- <code>git-sha</code> - Current commit SHA (for exact pinning)<br />- <code>package-json</code> - Read from package.json version field<br />- <code>explicit</code> - Use value from <code>version_override</code> input only | <code>git-tag</code> | **false** |
|
|
304
|
+
| <b><code>title_prefix</code></b> | Add a prefix to the README title.<br />The title template looks like this:<br /># {brand}{prefix}{title} | <code>GitHub Action: </code> | **false** |
|
|
305
|
+
| <b><code>include_github_version_badge</code></b> | Include additional badge showing latest tag | <code>true</code> | **false** |
|
|
306
|
+
| <b><code>branding_svg_path</code></b> | Create the branding svg image from the branding object in <code>action.yml</code><br />then save it to this path.<br />Then update the <code>README.md</code> file to source the branding image from this path.<br />You can use a section template like this:<br /><code>\<!-- start branding -->\<!-- stop branding --></code><br />or use the action input:<br /><code>branding_as_title_prefix: true</code><br />to prefix the 'title' section with the image.<br />The title template looks like this:<br /># {brand}{prefix}{title} | <code>.github/ghadocs/branding.svg</code> | **false** |
|
|
307
|
+
| <b><code>branding_as_title_prefix</code></b> | Prefix the title in the <code>\<!-- start title --></code> section with the svg branding image<br />The title template looks like this:<br /># {brand}{prefix}{title} | <code>true</code> | **false** |
|
|
308
308
|
|
|
309
309
|
<!-- end inputs -->
|
|
310
310
|
<!-- start outputs -->
|
|
311
311
|
|
|
312
|
-
| **Output**
|
|
313
|
-
|
|
|
314
|
-
| <code>sections</code> | A json object containing a map of section names to their new content | |
|
|
315
|
-
| <code>readme</code> | The path to the generated README.md file | |
|
|
316
|
-
| <code>readme_before</code> | The content of the readme file before the changes were made | |
|
|
317
|
-
| <code>readme_after</code> | The content of the readme file after the changes were made | |
|
|
312
|
+
| **Output** | **Description** | **Value** |
|
|
313
|
+
| --------------------------------- | -------------------------------------------------------------------- | --------- |
|
|
314
|
+
| <b><code>sections</code></b> | A json object containing a map of section names to their new content | |
|
|
315
|
+
| <b><code>readme</code></b> | The path to the generated README.md file | |
|
|
316
|
+
| <b><code>readme_before</code></b> | The content of the readme file before the changes were made | |
|
|
317
|
+
| <b><code>readme_after</code></b> | The content of the readme file after the changes were made | |
|
|
318
318
|
|
|
319
319
|
<!-- end outputs -->
|
|
320
320
|
|