From 4142d3bfe656bb02ab7e6e0bc215a5506d3f905f Mon Sep 17 00:00:00 2001 From: Paul Hatcherian <1835615+PaulHatch@users.noreply.github.com> Date: Thu, 22 Dec 2022 21:18:16 -0600 Subject: [PATCH] Documentation updates --- readme.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 6d08ce3..ae73a1e 100644 --- a/readme.md +++ b/readme.md @@ -106,10 +106,13 @@ it will be given the new version if the build were to be retriggered, for exampl - *major*, *minor*, and *patch* provide the version numbers that have been determined for this commit - *increment* is an additional value indicating the number of commits for the current version, starting at zero. This can be used as part of a pre-release label. - *version_type* is the type of version change the new version represents, e.g. `major`, `minor`, `patch`, or `none`. -- *version* is a formatted version string created using the format input. This is a convenience value to provide a preformatted representation of the data generated by this action. +- *formatted_version* is a formatted version string created using the format input. This is a convenience value to provide a preformatted representation of the data generated by this action. - *version_tag* is a string identifier that would be used to tag the current commit as the "released" version. Typically this would only be used to generate a Git tag name. - *changed* indicates whether there was a change since the last version if change_path was specified. If no `change_path` was specified this value will always be true since the entire repo is considered. (It is possible to create a commit with no changes, but the Git cli rejects this by default and this case is not considered here) - *authors* is a list of authors that have committed to this version, formatted as either csv or json. +- *current_commit* is the current commit hash. +- *previous_commit* is the previous commit hash. +- *previous_version* is the previous version. There are two types of "version" string, one is the semantic version output that can be used to identify a build and can include prerelease data and metadata specific to the commit such as `v2.0.1-pre001+cf6e75` (you would produce this string yourself using the version information from this action plus whatever metadata you wanted to add), the other is the tag version string, which identifies a specific commit as being a specific version.