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

Update readme

Browse source
This commit is contained in:
Paul Hatcherian 2023-09-13 22:13:14 -04:00
parent 0995adf892
commit d3c0da227f
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
readme.md
View file

@ -73,7 +73,7 @@ it will be given the new version if the build were to be retriggered, for exampl
<!-- start usage --> <!-- start usage -->
```yaml ```yaml
- uses: paulhatch/semantic-version@v5.1.0 - uses: paulhatch/semantic-version@v5.2.3
with: with:
# The prefix to use to identify tags # The prefix to use to identify tags
tag_prefix: "v" tag_prefix: "v"
@ -104,6 +104,8 @@ it will be given the new version if the build were to be retriggered, for exampl
# Prevents pre-v1.0.0 version from automatically incrementing the major version. # Prevents pre-v1.0.0 version from automatically incrementing the major version.
# If enabled, when the major version is 0, major releases will be treated as minor and minor as patch. Note that the version_type output is unchanged. # If enabled, when the major version is 0, major releases will be treated as minor and minor as patch. Note that the version_type output is unchanged.
enable_prerelease_mode: true enable_prerelease_mode: true
# If enabled, diagnostic information will be added to the action output.
debug: false
``` ```
## Outputs ## Outputs
@ -119,6 +121,7 @@ it will be given the new version if the build were to be retriggered, for exampl
- *current_commit* is the current commit hash. - *current_commit* is the current commit hash.
- *previous_commit* is the previous commit hash. - *previous_commit* is the previous commit hash.
- *previous_version* is the previous version. - *previous_version* is the previous version.
- *debug_output* will show diagnostic information, if debug is enabled
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.
@ -151,12 +154,12 @@ like `v1.2.3+0-db` could be configured like this:
```yaml ```yaml
- name: Application Version - name: Application Version
id: version id: version
uses: paulhatch/semantic-version@v5.1.0 uses: paulhatch/semantic-version@v5.2.2
with: with:
change_path: "src/service" change_path: "src/service"
- name: Database Version - name: Database Version
id: db-version id: db-version
uses: paulhatch/semantic-version@v5.1.0 uses: paulhatch/semantic-version@v5.2.2
with: with:
major_pattern: "(MAJOR-DB)" major_pattern: "(MAJOR-DB)"
minor_pattern: "(MINOR-DB)" minor_pattern: "(MINOR-DB)"