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

Readme updates

Browse source
This commit is contained in:
Paul Hatcherian 2020-11-28 11:17:28 -05:00
parent b75f063d41
commit 8430b15d4c
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
readme.md
View file

@ -32,10 +32,10 @@ goals:
- Resolve the version deterministically for a given commit (see caveats below) - Resolve the version deterministically for a given commit (see caveats below)
- Provide an easy mechanism for incrementing major and minor versions by developers - Provide an easy mechanism for incrementing major and minor versions by developers
The solution here is to calculate the _implicit_ next version based on the most To solve this problem, this action calculate the _implicit_ next version based on
recently tagged version and the commit messages. This is in essence, what this the most recently tagged version and the commit messages. An additional value called
tool does. An additional value called the "increment" tracks the number of commits the "increment" tracks the number of commits since the last version change, allowing
since the last version change, allowing preview tags to be created. a preview label to be created.
![Commits Graph](versioning.drawio.svg?raw=true) ![Commits Graph](versioning.drawio.svg?raw=true)
@ -54,7 +54,7 @@ of commits containing both will result in a major version increment.
## A Caveat Regarding Tags ## A Caveat Regarding Tags
Please note that if a tag is assigned to an older commit, the commits that come Please note that if a tag is assigned to an older commit, the commits that come
after it will be given the new new version, for example: after it will be given the new version, for example:
![Commits Graph](tagging.drawio.svg?raw=true) ![Commits Graph](tagging.drawio.svg?raw=true)
@ -63,7 +63,7 @@ after it will be given the new new version, for example:
<!-- start usage --> <!-- start usage -->
```yaml ```yaml
- uses: paulhatch/semantic-version@v3 - uses: paulhatch/semantic-version@v3.1.2
with: with:
# The branch to count commits on # The branch to count commits on
branch: "master" branch: "master"
@ -110,12 +110,12 @@ job referencing semantic version multiple times. For example:
```yaml ```yaml
- name: Application Version - name: Application Version
id: version id: version
uses: paulhatch/semantic-version@v3 uses: paulhatch/semantic-version@v3.1.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@v3 uses: paulhatch/semantic-version@v3.1.2
with: with:
major_pattern: "(MAJOR-DB)" major_pattern: "(MAJOR-DB)"
minor_pattern: "(MINOR-DB)" minor_pattern: "(MINOR-DB)"