Update readme.md

This commit is contained in:
Paul Hatcherian 2022-12-30 21:04:27 -06:00 committed by GitHub
parent 999339635f
commit d160cb59d5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -41,7 +41,7 @@ To solve this problem, this action calculates the next _implied_ version based o
the most recently tagged version and the commit messages. An additional value called the most recently tagged version and the commit messages. An additional value called
the "increment" tracks the count of commits since the last version change, allowing the "increment" tracks the count of commits since the last version change, allowing
a label to be created to mark pre-release versions. The version produced by this a label to be created to mark pre-release versions. The version produced by this
action is always the_implied version (unless `bump_each_commit` is set to `true`). action is always the implied version (unless `bump_each_commit` is set to `true`).
Subsequently tagging a commit that is chosen as the implied version is what bumps Subsequently tagging a commit that is chosen as the implied version is what bumps
the version for future commits. the version for future commits.
@ -75,7 +75,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.0.0 - uses: paulhatch/semantic-version@v5.0.1
with: with:
# The prefix to use to identify tags # The prefix to use to identify tags
tag_prefix: "v" tag_prefix: "v"
@ -147,12 +147,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.0.0 uses: paulhatch/semantic-version@v5.0.1
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.0.0 uses: paulhatch/semantic-version@v5.0.1
with: with:
major_pattern: "(MAJOR-DB)" major_pattern: "(MAJOR-DB)"
minor_pattern: "(MINOR-DB)" minor_pattern: "(MINOR-DB)"