froozeify/Froozeify's Version Updater (gVu)
Update version fields in configs on GitHub release. Supports auto-detection, file lists, and custom regex for any format.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| version | The version string to write. Defaults to the triggering tag name. On a release event, uses github.event.release.tag_name (always populated); otherwise falls back to github.ref_name. A leading 'v' prefix is automatically stripped (e.g. 'v1.2.3' → '1.2.3'). | no | ${{ github.event.release.tag_name || github.ref_name }} |
| files | Comma-separated list of files to update, e.g. "package.json,composer.json". Use "auto" (the default) to let the action detect known config files automatically. Supported auto-detected files: package.json, composer.json, pyproject.toml, Cargo.toml, pubspec.yaml. | no | auto |
| custom-rules | Additional update rules for file formats not natively supported. One rule per line, in the format: file:search_regex:replacement_template The placeholder {version} in the replacement is substituted with the clean version. Example: Chart.yaml:^version:\s*.*$:version: {version} version.txt:^.*$:{version} | no | "" |
| commit | Whether to commit and push the updated files back to the repository. Set to "false" to skip the commit step (useful when you want to run additional steps before committing, e.g. fetching a changelog). | no | true |
| commit-message | The commit message to use. The placeholder {version} is replaced with the clean version number. | no | ci: Bump version to {version} |
| commit-branch | The branch to push the version-bump commit to. | no | main |
| commit-author-name | The git author name for the version-bump commit. Defaults to "froozeify-gh-version-updater" so commits are clearly traceable to this action. | no | froozeify-gh-version-updater |
| commit-author-email | The git author email for the version-bump commit. | no | froozeify-gh-version-updater[bot]@users.noreply.github.com |
| token | GitHub token used to push the commit. Needs 'contents: write' permission. | no | ${{ github.token }} |
Outputs
| name | description |
|---|---|
| version | The clean version number that was written (without 'v' prefix). |
| files-updated | Space-separated list of files that were actually modified. |