aether/vociferate
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 7 Wiki Activity

docs: update action and README to reflect changelog-based versioning default
All checks were successful
Push Validation / validate (push) Successful in 54s
Details

Browse Source 
- action.yml: clarify that version-file triggers version-file-based
  resolution and that omitting it causes the version to be derived from
  the changelog; note version-pattern is only required when version-file
  is set.
- README: replace stale reference to the plain-text release-version file
  as the default with an accurate description of changelog-based
  versioning as the default, directing users to set version-file and
  version-pattern only for repos with source-embedded versioning.
This commit is contained in:
Micheal Wilkinson
2026-03-20 20:12:38 +00:00
parent 8c2835fe2e
commit 4ae6f34931
2 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -96,7 +96,7 @@ Use the composite action directly in your prepare workflow:
Set `version` only when you want to override the recommended version.
Pin the composite action to a released tag. It downloads a prebuilt Linux binary from vociferate releases and caches it on the runner, so it does not require installing Go.
If your repository uses the default plain-text `release-version` file, you can omit `version-file` and `version-pattern` entirely.
For repositories using changelog-based versioning (the default), omit `version-file` and `version-pattern` entirely. Only set them for repositories that embed the version inside source code.
A complete release setup should also split preparation from publication. For example:

4
action.yml
View File

@@ -10,11 +10,11 @@ inputs:
description: Optional semantic version override. When omitted, the recommended version is used.
required: false
version-file:
description: Path to version file relative to repository root.
description: Path to version file relative to repository root. When omitted, the current version is derived from the most recent released section in the changelog.
required: false
default: ''
version-pattern:
description: Regular expression with one capture group for current version.
description: Regular expression with one capture group for current version. Only required when version-file is set.
required: false
default: ''
changelog: