mirror of
https://github.com/PaulHatch/semantic-version.git
synced 2025-12-27 13:08:17 +00:00
Clarify namespace for new user
It took a bit to figure out how namespace works. This minor addition helps me with clarification; feel free to disagree with that opinion. :D
This commit is contained in:
parent
12cce3bff2
commit
13e0565bfd
1 changed files with 7 additions and 5 deletions
12
readme.md
12
readme.md
|
|
@ -115,15 +115,17 @@ not increase the `increment` output. In addition, if there are no changes in
|
||||||
a given commit with this path specified, the `changed` value will be false.
|
a given commit with this path specified, the `changed` value will be false.
|
||||||
|
|
||||||
Second, the input `namespace` can be set to create an additional named version.
|
Second, the input `namespace` can be set to create an additional named version.
|
||||||
If this value is set, it will be appended to the end of tags for the version,
|
If this value is set, it will be appended (separated by a hyphen) to the end of
|
||||||
and only tags with this value appended will be considered when determining the
|
tags for the version, and only tags with this value appended will be considered
|
||||||
version.
|
when determining the version. The namespace will be pruned from the string
|
||||||
|
output as "version" within the action.
|
||||||
|
|
||||||
Finally, set different values for `major_pattern` and `minor_pattern` than the
|
Finally, set different values for `major_pattern` and `minor_pattern` than the
|
||||||
other projects in order to be able to mark these commits independently.
|
other projects in order to be able to mark these commits independently.
|
||||||
|
|
||||||
To use secondary versions in a workflow, simply create additional steps in a
|
To use secondary versions in a workflow, simply create additional steps in a
|
||||||
job referencing semantic version multiple times. For example:
|
job referencing semantic version multiple times. For example, a project tagged
|
||||||
|
like `v1.2.3+0-db` could be configured like this:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- name: Application Version
|
- name: Application Version
|
||||||
|
|
@ -153,4 +155,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
|
||||||
```
|
```
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue