From 13e0565bfdb4f21fa547197e99289d08d2c2e2e0 Mon Sep 17 00:00:00 2001 From: Danny Sauer Date: Mon, 25 Jan 2021 17:09:13 -0600 Subject: [PATCH] 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 --- readme.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/readme.md b/readme.md index de738ae..3217080 100644 --- a/readme.md +++ b/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. 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, -and only tags with this value appended will be considered when determining the -version. +If this value is set, it will be appended (separated by a hyphen) to the end of +tags for the version, and only tags with this value appended will be considered +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 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 -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 - name: Application Version @@ -153,4 +155,4 @@ zero to pull the full history and tags. uses: actions/checkout@v2 with: fetch-depth: 0 -``` \ No newline at end of file +```