actions/semantic-version
6
0
Fork 0
mirror of https://github.com/PaulHatch/semantic-version.git synced 2025-12-27 13:08:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update documentation for v5

Browse source
This commit is contained in:
Paul Hatcherian 2022-04-03 22:04:42 -04:00
parent d508520389
commit 0c47e4e106
2 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
action.yml
View file

@ -57,6 +57,8 @@ outputs:
description: "The version tag" description: "The version tag"
changed: changed:
description: "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." description: "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."
authors:
description: "List of users contributing commits to this version"
runs: runs:
using: "node16" using: "node16"
main: "dist/index.js" main: "dist/index.js"

5
readme.md
View file

@ -92,6 +92,10 @@ it will be given the new version if the build were to be retriggered, for exampl
short_tags: true short_tags: true
# If this is set to true, *every* commit will be treated as a new version. # If this is set to true, *every* commit will be treated as a new version.
bump_each_commit: false bump_each_commit: false
# If true, the body of commits will also be searched for major/minor patterns to determine the version type.
search_commit_body: false
# The output method used to generate list of users, 'csv' or 'json'.
user_format_type: "csv"
``` ```
## Outputs ## Outputs
@ -101,6 +105,7 @@ it will be given the new version if the build were to be retriggered, for exampl
- *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* 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. - *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) - *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.
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. 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.