actions/semantic-version
6
0
Fork 0
mirror of https://github.com/PaulHatch/semantic-version.git synced 2025-12-28 21:38:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update readme format/wording

Browse source
This commit is contained in:
Paul Hatcherian 2021-01-23 07:28:04 -05:00
parent c81b8f3498
commit 12cce3bff2
1 changed files with 6 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
readme.md
View file

@ -39,6 +39,8 @@ a label to be created to mark pre-release versions.
![Commits Graph](versioning.drawio.svg?raw=true) ![Commits Graph](versioning.drawio.svg?raw=true)
_Unless the current commit is already tagged, the version produced by this action will be one value ahead of the last tag._
## Major and Minor Versions ## Major and Minor Versions
The commit messages for the span of commits from the last tag are checked for the The commit messages for the span of commits from the last tag are checked for the
@ -51,7 +53,7 @@ of commits containing both will result in a major version increment.
![Commits Graph](minor.drawio.svg?raw=true) ![Commits Graph](minor.drawio.svg?raw=true)
## A Note Regarding Tags ## Tags on Previous Commits
Adding a tag to an older commit changes the implicit version of commits since the Adding a tag to an older commit changes the implicit version of commits since the
tagged commit. If a tag is assigned to an older commit, the commits that come after tagged commit. If a tag is assigned to an older commit, the commits that come after
@ -97,6 +99,8 @@ it will be given the new version if the build were to be retriggered, for exampl
- *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)
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.
## Using Multiple Versions in the Same Repository ## Using Multiple Versions in the Same Repository
It is possible to create additional versions for multiple project co-existing It is possible to create additional versions for multiple project co-existing
@ -149,9 +153,4 @@ zero to pull the full history and tags.
uses: actions/checkout@v2 uses: actions/checkout@v2
with: with:
fetch-depth: 0 fetch-depth: 0
``` ```
## Tips for Getting Started
- Unless the current commit is already tagged, the version produced by this action will be one value ahead of the last tag.
- 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`, the other is the tag version string, which identifies a specific commit as being a specific version.