From 44deb2468380342d384f3f12d55a7acb92c6deca Mon Sep 17 00:00:00 2001 From: Jeremiah Zucker Date: Fri, 12 Jul 2024 16:49:01 -0400 Subject: [PATCH] update version-file docs to reflect change --- plugins/version-file/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/version-file/README.md b/plugins/version-file/README.md index 2043ad867..9ff4c6449 100644 --- a/plugins/version-file/README.md +++ b/plugins/version-file/README.md @@ -17,7 +17,7 @@ yarn add -D @auto-it/version-file ## Options - versionFile (optional, default="VERSION"): Path to where the version is stored in the repository. It should be a file containing just the semver. -- releaseScript: (optional, default=None): Path to script that runs the publish actions in your repository. If not supplied nothing will be called. If supplied will be called during the `publish`,`canary` and `next` hooks. For the `publish` hook the first parameter passed to the script will be `release` to indicate that a regular release is being called. For `canary` and `next` hooks the first parameter will be `snapshot` to indicate a prerelease version. +- releaseScript: (optional, default=None): Path to script that runs the publish actions in your repository. If not supplied nothing will be called. If supplied will be called during the `publish`,`canary` and `next` hooks. For the `publish` hook the first parameter passed to the script will be `release` to indicate that a regular release is being called. For `canary` and `next` hooks the first parameter will be `canary` or `next` to indicate a prerelease version, and let the consumer handle what to do for those types of releases. ## Usage @@ -36,4 +36,4 @@ yarn add -D @auto-it/version-file "plugins": [ "version-file", {"versionFile": "./tools/Version.txt", "releaseScript":"./tools/publish.sh"} ] -} \ No newline at end of file +}