From 4ae6f34931460b970c3d8d356b6938ee4fb63922 Mon Sep 17 00:00:00 2001 From: Micheal Wilkinson Date: Fri, 20 Mar 2026 20:12:38 +0000 Subject: [PATCH] docs: update action and README to reflect changelog-based versioning default - 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. --- README.md | 2 +- action.yml | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c03fa2e..44d4ae9 100644 --- a/README.md +++ b/README.md @@ -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: diff --git a/action.yml b/action.yml index edfc1d2..416730c 100644 --- a/action.yml +++ b/action.yml @@ -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: