Document changes to gitService.branch

This commit is contained in:
Andres Almiray
2021-05-07 12:33:05 +02:00
parent e18161bdb7
commit 515e574083
4 changed files with 16 additions and 16 deletions

View File

@@ -187,7 +187,7 @@ The following key/values may be defined in the properties file or as environment
| JRELEASER_TAG_NAME | the release tag name
| JRELEASER_RELEASE_NAME | the release name
| JRELEASER_MILESTONE_NAME | the milestone name/title
| JRELEASER_BRANCH | the release branch (targetCommitish/ref)
| JRELEASER_BRANCH | the release branch
| JRELEASER_OVERWRITE | overwrite an existing release
| JRELEASER_UPDATE | update an existing release
| JRELEASER_SKIP_TAG | skip tagging the release

View File

@@ -235,7 +235,7 @@ release:
# May define a `JRELEASER_BRANCH` environment variable instead.
# Defaults to the branch pointed by HEAD.
# icon:dot-circle[] icon:eye-slash[]
targetCommitish: main
branch: main
# Marks the release as a draft.
# May define a `JRELEASER_DRAFT` environment variable instead.
@@ -498,7 +498,7 @@ TOML::
# May define a `JRELEASER_BRANCH` environment variable instead.
# Defaults to the branch pointed by HEAD.
# icon:dot-circle[] icon:eye-slash[]
targetCommitish = "main"
branch = "main"
# Marks the release as a draft.
# May define a `JRELEASER_DRAFT` environment variable instead.
@@ -785,7 +785,7 @@ JSON::
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to the branch pointed by HEAD.
// icon:dot-circle[] icon:eye-slash[]
"targetCommitish": "main",
"branch": "main",
// Marks the release as a draft.
// May define a `JRELEASER_DRAFT` environment variable instead.
@@ -1161,7 +1161,7 @@ Maven::
Defaults to the branch pointed by HEAD.
icon:dot-circle[] icon:eye-slash[]
-->
<targetCommitish>main</targetCommitish>
<branch>main</branch>
<!--
Marks the release as a draft.
@@ -1465,7 +1465,7 @@ jreleaser {
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to the branch pointed by HEAD.
// icon:dot-circle[]v
targetCommitish = 'main'
branch = 'main'
// Marks the release as a draft.
// May define a `JRELEASER_DRAFT` environment variable instead.

View File

@@ -238,7 +238,7 @@ release:
# May define a `JRELEASER_BRANCH` environment variable instead.
# Defaults to the branch pointed by HEAD.
# icon:dot-circle[] icon:eye-slash[]
targetCommitish: main
branch: main
# Marks the release as a draft.
# May define a `JRELEASER_DRAFT` environment variable instead.
@@ -502,7 +502,7 @@ TOML::
# May define a `JRELEASER_BRANCH` environment variable instead.
# Defaults to the branch pointed by HEAD.
# icon:dot-circle[] icon:eye-slash[]
targetCommitish = "main"
branch = "main"
# Marks the release as a draft.
# May define a `JRELEASER_DRAFT` environment variable instead.
@@ -792,7 +792,7 @@ JSON::
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to the branch pointed by HEAD.
// icon:dot-circle[] icon:eye-slash[]
"targetCommitish": "main",
"branch": "main",
// Marks the release as a draft.
// May define a `JRELEASER_DRAFT` environment variable instead.
@@ -1171,7 +1171,7 @@ Maven::
Defaults to the branch pointed by HEAD.
icon:dot-circle[] icon:eye-slash[]
-->
<targetCommitish>main</targetCommitish>
<branch>main</branch>
<!--
Marks the release as a draft.
@@ -1478,7 +1478,7 @@ jreleaser {
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to the branch pointed by HEAD.
// icon:dot-circle[]v
targetCommitish = 'main'
branch = 'main'
// Marks the release as a draft.
// May define a `JRELEASER_DRAFT` environment variable instead.

View File

@@ -238,7 +238,7 @@ release:
# May define a `JRELEASER_BRANCH` environment variable instead.
# Defaults to the branch pointed by HEAD.
# icon:dot-circle[] icon:eye-slash[]
ref: main
branch: main
# The following properties define icon:dot-circle[] URL formats.
# Defaults are shown.
@@ -491,7 +491,7 @@ TOML::
# May define a `JRELEASER_BRANCH` environment variable instead.
# Defaults to the branch pointed by HEAD.
# icon:dot-circle[] icon:eye-slash[]
ref = "main"
branch = "main"
# The following properties define icon:dot-circle[] URL formats.
# Defaults are shown.
@@ -769,7 +769,7 @@ JSON::
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to the branch pointed by HEAD.
// icon:dot-circle[] icon:eye-slash[]
"ref": "main",
"branch": "main",
// The following properties define icon:dot-circle[] URL formats.
// Defaults are shown.
@@ -1135,7 +1135,7 @@ Maven::
Defaults to the branch pointed by HEAD.
icon:dot-circle[] icon:eye-slash[]
-->
<ref>main</ref>
<branch>main</branch>
<!--
The following properties define icon:dot-circle[] URL formats.
@@ -1426,7 +1426,7 @@ jreleaser {
// May define a `JRELEASER_BRANCH` environment variable instead.
// Defaults to the branch pointed by HEAD.
// icon:dot-circle[] icon:eye-slash[]
ref = 'main'
branch = 'main'
// The following properties define icon:dot-circle[] URL formats.
// Defaults are shown.