github-action-readme-generator 1.9.2 → 1.10.0

package/CHANGELOG.md

@@ -1,3 +1,28 @@
+# [1.10.0](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.9.3...v1.10.0) (2026-02-04)
+
+
+### Features
+
+* add version_source input for flexible version detection ([d8cbcfd](https://github.com/bitflight-devops/github-action-readme-generator/commit/d8cbcfdb5a1e32d25f94f20dd5078195647a0b7e))
+
+## [1.9.3](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.9.2...v1.9.3) (2026-02-04)
+
+
+### Bug Fixes
+
+* auto-detect owner/repo/version from target repo directory ([c3099a5](https://github.com/bitflight-devops/github-action-readme-generator/commit/c3099a59fb75f14d2444a4978ff31383587cf9bd))
+* detect version from target repo releases/tags ([f20021d](https://github.com/bitflight-devops/github-action-readme-generator/commit/f20021dbb67ab40408e70b079958f0083dac2907))
+* document project's actual rule enforcement, not Biome defaults ([8006731](https://github.com/bitflight-devops/github-action-readme-generator/commit/800673191577a64eb6ad39b6890910380745864e))
+* enable strict Biome linting and fix all violations ([8506785](https://github.com/bitflight-devops/github-action-readme-generator/commit/85067859b45980fe350d2ae0b87e2e01c6e6195f))
+* fail integration tests when validation checks fail ([42898b4](https://github.com/bitflight-devops/github-action-readme-generator/commit/42898b42a2720de38948107a89e6753b5b43d694))
+* fetch tags when checking out test repositories ([c2c61c7](https://github.com/bitflight-devops/github-action-readme-generator/commit/c2c61c77481f29a3967c8bb892eb76ae563777e5))
+* handle .git URLs without suffix in actions/checkout ([e694d09](https://github.com/bitflight-devops/github-action-readme-generator/commit/e694d091439416cb0c535fb38cf25abc096a5be9))
+* pass owner/repo to integration tests ([4e4c3fd](https://github.com/bitflight-devops/github-action-readme-generator/commit/4e4c3fdf998dc794ec8f2d67ceb23acb7febbdd5))
+* prioritize .git/config from target directory over GITHUB_REPOSITORY ([ac2e10e](https://github.com/bitflight-devops/github-action-readme-generator/commit/ac2e10ef62dff20992d146092cb65d94f6bb1c1a))
+* prioritize git tags for version detection (GitHub Actions standard) ([e5c9434](https://github.com/bitflight-devops/github-action-readme-generator/commit/e5c943446c445568a085fa6f673dc4f7c5b61f94))
+* replace forEach exception with proper for...of entries() pattern ([6f5873c](https://github.com/bitflight-devops/github-action-readme-generator/commit/6f5873c44d4a345c712d906155d047d414c2325f))
+* show full diff in integration test output ([acee396](https://github.com/bitflight-devops/github-action-readme-generator/commit/acee39619dc8f1a208aed80ad2d72320d5d8940a))
+
 ## [1.9.2](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.9.1...v1.9.2) (2026-02-01)
 
 

package/README.md

@@ -177,7 +177,7 @@ This configuration will automatically regenerate your README whenever `action.ym
 <!-- start usage -->
 
 ```yaml
-- uses: bitflight-devops/github-action-readme-generator@v1.9.1
+- uses: bitflight-devops/github-action-readme-generator@v1
   with:
     # Description: The absolute or relative path to the `action.yml` file to read in
     # from.
@@ -237,6 +237,17 @@ This configuration will automatically regenerate your README whenever `action.ym
     # Default: main
     versioning_default_branch: ""
 
+    # Description: How to detect the action version for the usage example. Options:
+    #
+    # - `git-tag` - Latest git tag (default, standard for GitHub Actions)
+    # - `git-branch` - Current branch name (for bleeding edge users)
+    # - `git-sha` - Current commit SHA (for exact pinning)
+    # - `package-json` - Read from package.json version field
+    # - `explicit` - Use value from `version_override` input only
+    #
+    # Default: git-tag
+    version_source: ""
+
     # Description: Add a prefix to the README title. The title template looks like
     # this:
     #
@@ -289,6 +300,7 @@ This configuration will automatically regenerate your README whenever `action.ym
 | <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**    |
 | <code>version_prefix</code>               | Prefix the version with this value, if it isn't already prefixed                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | <code>v</code>                            | **false**    |
 | <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**    |
+| <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**    |
 | <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**    |
 | <code>include_github_version_badge</code> | Include additional badge showing latest tag                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | <code>true</code>                         | **false**    |
 | <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**    |

package/action.yml

@@ -69,6 +69,23 @@ inputs:
       `uses: reviewdog/action-eslint@main`
     required: false
     default: main
+  version_source:
+    description: >
+      How to detect the action version for the usage example.
+
+      Options:
+
+      - `git-tag` - Latest git tag (default, standard for GitHub Actions)
+
+      - `git-branch` - Current branch name (for bleeding edge users)
+
+      - `git-sha` - Current commit SHA (for exact pinning)
+
+      - `package-json` - Read from package.json version field
+
+      - `explicit` - Use value from `version_override` input only
+    required: false
+    default: git-tag
   title_prefix:
     description: |
       Add a prefix to the README title.