Bintray Maven Plugin – bintray:deploy

bintray:deploy

Full name:

com.carrotgarden.maven:bintray-maven-plugin:1.5.20191113163933:deploy

Description:

Deploy Maven build project artifacts to existing Bintray Maven repository. Goal operates via Bintray REST API.

Attributes:

Requires a Maven project to be executed.
Binds by default to the lifecycle phase: deploy.

Optional Parameters

Name	Type	Since	Description
`<bintrayPackage>`	`String`	`-`	Bintray target repository package. Corresponds to `X-Bintray-Package` rest header. Default value is: `${project.artifactId}`. User property is: `bintray.bintrayPackage`.
`<bintrayVersion>`	`String`	`-`	Bintray target repository version. Corresponds to `X-Bintray-Version` rest header. Default value is: `${project.version}`. User property is: `bintray.bintrayVersion`.
`<downloadUrl>`	`String`	`-`	Bintray public download URL. Default value is: `https://dl.bintray.com`. User property is: `bintray.downloadUrl`.
`<packageLicenses>`	`String[]`	`-`	Bintray package create definition parameter: licenses list to attach to the target package (rest parameter: `licenses`). Default value is: `Apache-2.0`. User property is: `bintray.packageLicenses`.
`<packageVcsUrl>`	`String`	`-`	Bintray package create definition parameter: version control system url (rest parameter: `vcs_url`). Default value is: `${project.url}`. User property is: `bintray.packageVcsUrl`.
`<password>`	`String`	`-`	Bintray rest-api-token for authentication. When missing, uses serverId / `password` from settings.xml. <server> <id>distro-bintray</id> <username>...</username> <password>...</password> </server> User property is: `bintray.password`.
`<performCleanup>`	`boolean`	`-`	Execution step 5: optionally remove previous versions with files from target bintray package after the deployment. Preserve select versions via preserveRegex. Default value is: `true`. User property is: `bintray.performCleanup`.
`<performDeploy>`	`boolean`	`-`	Execution step 3: actually do invoke artifact deployment to the target repository. Default value is: `true`. User property is: `bintray.performDeploy`.
`<performDestroy>`	`boolean`	`-`	Execution step 1: optionally remove target bintray package with all versions and files. Default value is: `false`. User property is: `bintray.performDestroy`.
`<performEnsure>`	`boolean`	`-`	Execution step 2: optionally create target bintray package before deployment. Use create parameters: packageName, packageVcsUrl, packageLicenses. Default value is: `true`. User property is: `bintray.performEnsure`.
`<performPublish>`	`boolean`	`-`	Execution step 4: optionally mark deployment artifact as "published for bintray consumption" after the deployment. Default value is: `true`. User property is: `bintray.performPublish`.
`<preserveRegex>`	`String`	`-`	Deploy behaviour: during deployment cleanup, preserve versions with version description matching given Java regular expression. Default value is: `(PRESERVE)`. User property is: `bintray.preserveRegex`.
`<repository>`	`String`	`-`	Bintray target repository name. Repository must already exist for the bintray subject. Default value is: `repo`. User property is: `bintray.repository`.
`<restApiUrl>`	`String`	`-`	Bintray REST API URL. Default value is: `https://bintray.com/api/v1`. User property is: `bintray.restApiUrl`.
`<restConnectTimeout>`	`int`	`-`	REST api connection timeout, seconds. Default value is: `30`. User property is: `bintray.restConnectTimeout`.
`<restReadTimeout>`	`int`	`-`	REST api read operation timeout, seconds. Default value is: `30`. User property is: `bintray.restReadTimeout`.
`<restWriteTimeout>`	`int`	`-`	REST api write operation timeout, seconds. Default value is: `30`. User property is: `bintray.restWriteTimeout`.
`<retryFailedDeploymentCount>`	`int`	`-`	Parameter used to control how many times a failed deployment will be retried before giving up and failing. If a value outside the range 1-10 is specified it will be pulled to the nearest value within the range 1-10. Default value is: `1`. User property is: `retryFailedDeploymentCount`.
`<serverId>`	`String`	`-`	Server id for credentials lookup: `username`, `password` from settings.xml. Used when not provided via parameters: username, password. <server> <id>distro-bintray</id> <username>...</username> <password>...</password> </server> Configure this `serverId` as `proxy/id` for optional proxy setup. Note: bintray credentials and proxy credentials are unrelated. <proxy> <id>distro-bintray</id> <username>...</username> <password>...</password> </proxy> Default value is: `distro-bintray`. User property is: `bintray.serverId`.
`<skip>`	`boolean`	`-`	Flag to skip all steps of the deployment execution. Default value is: `false`. User property is: `bintray.skip`.
`<subject>`	`String`	`-`	Bintray user or organization name which contains target repository. Default value is: `${user.name}`. User property is: `bintray.subject`.
`<updateReleaseInfo>`	`boolean`	`-`	(no description) Default value is: `false`. User property is: `updateReleaseInfo`.
`<username>`	`String`	`-`	Bintray rest-api-actor for authentication. When missing, uses serverId / `username` from settings.xml. <server> <id>distro-bintray</id> <username>...</username> <password>...</password> </server> User property is: `bintray.username`.

Parameter Details

<bintrayPackage>

Bintray target repository package. Corresponds to X-Bintray-Package rest header.

Type: java.lang.String
Required: No
User Property: bintray.bintrayPackage
Default: ${project.artifactId}

<bintrayVersion>

Bintray target repository version. Corresponds to X-Bintray-Version rest header.

Type: java.lang.String
Required: No
User Property: bintray.bintrayVersion
Default: ${project.version}

<downloadUrl>

Bintray public download URL.

Type: java.lang.String
Required: No
User Property: bintray.downloadUrl
Default: https://dl.bintray.com

<packageLicenses>

Bintray package create definition parameter: licenses list to attach to the target package (rest parameter: licenses).

Type: java.lang.String[]
Required: No
User Property: bintray.packageLicenses
Default: Apache-2.0

<packageVcsUrl>

Bintray package create definition parameter: version control system url (rest parameter: vcs_url).

Type: java.lang.String
Required: No
User Property: bintray.packageVcsUrl
Default: ${project.url}

<password>

Bintray rest-api-token for authentication. When missing, uses serverId / password from settings.xml.

<server>
  <id>distro-bintray</id>
  <username>...</username>
  <password>...</password>
</server>

Type: java.lang.String
Required: No
User Property: bintray.password

<performCleanup>

Execution step 5: optionally remove previous versions with files from target bintray package after the deployment. Preserve select versions via preserveRegex.

Type: boolean
Required: No
User Property: bintray.performCleanup
Default: true

<performDeploy>

Execution step 3: actually do invoke artifact deployment to the target repository.

Type: boolean
Required: No
User Property: bintray.performDeploy
Default: true

<performDestroy>

Execution step 1: optionally remove target bintray package with all versions and files.

Type: boolean
Required: No
User Property: bintray.performDestroy
Default: false

<performEnsure>

Execution step 2: optionally create target bintray package before deployment. Use create parameters: packageName, packageVcsUrl, packageLicenses.

Type: boolean
Required: No
User Property: bintray.performEnsure
Default: true

<performPublish>

Execution step 4: optionally mark deployment artifact as "published for bintray consumption" after the deployment.

Type: boolean
Required: No
User Property: bintray.performPublish
Default: true

<preserveRegex>

Deploy behaviour: during deployment cleanup, preserve versions with version description matching given Java regular expression.

Type: java.lang.String
Required: No
User Property: bintray.preserveRegex
Default: (PRESERVE)

<repository>

Bintray target repository name. Repository must already exist for the bintray subject.

Type: java.lang.String
Required: No
User Property: bintray.repository
Default: repo

<restApiUrl>

Bintray REST API URL.

Type: java.lang.String
Required: No
User Property: bintray.restApiUrl
Default: https://bintray.com/api/v1

<restConnectTimeout>

REST api connection timeout, seconds.

Type: int
Required: No
User Property: bintray.restConnectTimeout
Default: 30

<restReadTimeout>

REST api read operation timeout, seconds.

Type: int
Required: No
User Property: bintray.restReadTimeout
Default: 30

<restWriteTimeout>

REST api write operation timeout, seconds.

Type: int
Required: No
User Property: bintray.restWriteTimeout
Default: 30

Parameter used to control how many times a failed deployment will be retried before giving up and failing. If a value outside the range 1-10 is specified it will be pulled to the nearest value within the range 1-10.

Type: int
Required: No
User Property: retryFailedDeploymentCount
Default: 1

<serverId>

Server id for credentials lookup: username, password from settings.xml. Used when not provided via parameters: username, password.

<server>
  <id>distro-bintray</id>
  <username>...</username>
  <password>...</password>
</server>

Configure this serverId as proxy/id for optional proxy setup. Note: bintray credentials and proxy credentials are unrelated.

<proxy>
  <id>distro-bintray</id>
  <username>...</username>
  <password>...</password>
</proxy>

Type: java.lang.String
Required: No
User Property: bintray.serverId
Default: distro-bintray

<skip>

Flag to skip all steps of the deployment execution.

Type: boolean
Required: No
User Property: bintray.skip
Default: false

<subject>

Bintray user or organization name which contains target repository.

Type: java.lang.String
Required: No
User Property: bintray.subject
Default: ${user.name}

<updateReleaseInfo>

(no description)

Type: boolean
Required: No
User Property: updateReleaseInfo
Default: false

<username>

Bintray rest-api-actor for authentication. When missing, uses serverId / username from settings.xml.

<server>
  <id>distro-bintray</id>
  <username>...</username>
  <password>...</password>
</server>

Type: java.lang.String
Required: No
User Property: bintray.username