Skip to content

Commit 44deb24

Browse files
authored
update version-file docs to reflect change
1 parent 3a38fdd commit 44deb24

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

plugins/version-file/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ yarn add -D @auto-it/version-file
1717
## Options
1818

1919
- versionFile (optional, default="VERSION"): Path to where the version is stored in the repository. It should be a file containing just the semver.
20-
- 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.
20+
- 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.
2121

2222
## Usage
2323

@@ -36,4 +36,4 @@ yarn add -D @auto-it/version-file
3636
"plugins": [
3737
"version-file", {"versionFile": "./tools/Version.txt", "releaseScript":"./tools/publish.sh"}
3838
]
39-
}
39+
}

0 commit comments

Comments
 (0)