Skip to content

Commit

Permalink
Update documentation for v5
Browse files Browse the repository at this point in the history
  • Loading branch information
PaulHatch committed Apr 4, 2022
1 parent d508520 commit 0c47e4e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
2 changes: 2 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ outputs:
description: "The version tag"
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."
authors:
description: "List of users contributing commits to this version"
runs:
using: "node16"
main: "dist/index.js"
5 changes: 5 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,10 @@ it will be given the new version if the build were to be retriggered, for exampl
short_tags: true
# If this is set to true, *every* commit will be treated as a new version.
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
Expand All @@ -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_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.

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.

Expand Down

0 comments on commit 0c47e4e

Please sign in to comment.