Fork me on GitHub

central-publishing:publish

Full name:

io.github.mavenplugins:central-publishing-maven-plugin:1.1.1:publish

Description:

No description.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: deploy.
  • Requires that Maven runs in online mode.

Required Parameters

Name Type Since Description
<outputFilename> String 0.1.1 Name of the bundle file that the plugin will output as a result.
Default: central-bundle.zip
User Property: outputFilename
<skipPublishing> boolean 0.1.1 For creating only the bundle but skipping uploading and publishing. This is useful for creating a bundle and manually uploading it through central.sonatype.com.
Default: false
User Property: skipPublishing

Optional Parameters

Name Type Since Description
<autoPublish> boolean 0.2.0 Assign whether to auto publish a deployment. Meaning that no manual intervention is required, if a deployment is considered valid, before publishing it. Defaults to Constants.AUTO_PUBLISH_DEFAULT_VALUE.
Default: false
User Property: autoPublish
<centralBaseUrl> String 0.1.1 Assign the URL that this plugin uses to publish releases. Defaults to Constants.CENTRAL_BASE_URL_DEFAULT_VALUE.
Default: https://central.sonatype.com
User Property: centralBaseUrl
<centralSnapshotsUrl> String 0.7.0 URL that this plugin uses to publish snapshots to. Used by org.sonatype.central.publisher.plugin.deffer.ArtifactDeferrerImpl.getDeploymentRepository(org.apache.maven.execution.MavenSession,java.lang.String,java.lang.String) as follows:

a) Use this URL if it is set and publishingServerId is set.

b) Use repo URL defined by distributionManagement from project POM if this is defined.

c) Use Constants.CENTRAL_SNAPSHOTS_URL_DEFAULT_VALUE as default if publishingServerId is set.
User Property: centralSnapshotsUrl
<checksums> String 0.1.1 Assign what type of checksums will be generated for files. Three options are available:

all - Will request MD5, SHA1, SHA256 and SHA512 to be generated.

required - Only MD5 and SHA1 will be requested to be generated.

none - No Checksums will be requested to be generated.


Default: ALL
User Property: checksums
<deploymentName> String 0.1.1 Name of the deployment that's used for uploading and deploying on the central url. If using central.sonatype.com, this is the name that will be visible on the Deployments page.
Default: Deployment
User Property: deploymentName
<dropValidated> boolean 1.0.0 Assign whether to drop a deployment in validated state. Meaning that the deployment is deleted after validation succeeded. This configuration is effective only, if autoPublish is not set true. Defaults to Constants.DROP_VALIDATED_DEFAULT_VALUE.
Default: false
User Property: dropValidated
<excludeArtifacts> List<String> 0.1.6 Assign artifacts that must not be added to the bundle that represents the deployment that will be published.
User Property: excludeArtifacts
<failOnBuildFailure> boolean 0.1.1 Indicates if building is allowed to have the plugin fail before uploading and publishing occurs.
Default: true
User Property: failOnBuildFailure
<forcedDeferredDirectory> File 0.7.0 Name of the directory where the plugin will defer snapshot files.
Note: this directory will be cleaned on the first execution of this plugin.
User Property: deferredDirectory
<forcedOutputDirectory> File 0.1.1 Name of the directory that the plugin will output the bundle file into.
Note: this directory will be cleaned on the first execution of this plugin.
User Property: outputDirectory
<forcedStagingDirectory> File 0.1.1 Name of the directory where the plugin will stage files.
Note: this directory will be cleaned on the first execution of this plugin.
User Property: stagingDirectory
<ignorePublishedComponents> boolean 0.1.6 Assign whether we ignore, or more specifically, not add components that have already been published in the past to the bundle that will be published. When working with projects that are using a multi-module setup, and it's desired to publish only new modules (for example parent, child1 and child2 are all published, and it's desired to publish a new version X.Y.1 of child2, but leave child1 and parent unchanged), this setting will assure that previous published components will not be published again, which will cause the publishing to fail. Defaults to Constants.IGNORE_PUBLISHED_COMPONENTS_DEFAULT_VALUE.
Default: false
User Property: ignorePublishedComponents
<publishCompletionPollInterval> int 0.1.1
Deprecated.
use waitPollingInterval instead

No description.
Default: 1000
User Property: publishCompletionPollInterval
<publishingServerId> String 0.1.1 ID of the server that you configured in your settings.xml.
Default: central
User Property: publishingServerId
<skipBundling> boolean 1.1.0 For skipping artifacts bundling. This is particularly useful for multi-module build, where some sub-modules should not be included in the final bundle that will be uploaded to central.sonatype.com.
Default: false
User Property: skipBundling
<waitForPublishCompletion> boolean 0.1.1
Deprecated.
use autoPublish in combination with waitUntil instead

No description.
Default: false
User Property: waitForPublishCompletion
<waitMaxTime> int 0.2.0 Assign the amount of seconds that the plugin will wait for a deployment state. Can not be less than Constants.WAIT_MAX_TIME_DEFAULT_VALUE.
Default: 1800
User Property: waitMaxTime
<waitPollingInterval> int 0.2.0 Assign the amount of seconds between checking whether a deployment has published. Can not be less than Constants.WAIT_POLLING_INTERVAL_DEFAULT_VALUE.
Default: 5
User Property: waitPollingInterval
<waitUntil> String 0.2.0 Assign what to wait for, if desired to wait, of the processing of a deployment. See @org.sonatype.central.publisher.plugin.model.WaitUntilRequest for options.

uploaded - Wait until the bundle is being uploaded.

validated - Wait until the uploaded bundle is validated.

published - Wait until the uploaded bundle is published to Maven Central.

Defaults to Constants.WAIT_UNTIL_DEFAULT_VALUE.
Default: VALIDATED
User Property: waitUntil

Parameter Details

<autoPublish>

Assign whether to auto publish a deployment. Meaning that no manual intervention is required, if a deployment is considered valid, before publishing it. Defaults to Constants.AUTO_PUBLISH_DEFAULT_VALUE.
  • Type: boolean
  • Since: 0.2.0
  • Required: No
  • User Property: autoPublish
  • Default: false

<centralBaseUrl>

Assign the URL that this plugin uses to publish releases. Defaults to Constants.CENTRAL_BASE_URL_DEFAULT_VALUE.
  • Type: java.lang.String
  • Since: 0.1.1
  • Required: No
  • User Property: centralBaseUrl
  • Default: https://central.sonatype.com

<centralSnapshotsUrl>

URL that this plugin uses to publish snapshots to. Used by org.sonatype.central.publisher.plugin.deffer.ArtifactDeferrerImpl.getDeploymentRepository(org.apache.maven.execution.MavenSession,java.lang.String,java.lang.String) as follows:

a) Use this URL if it is set and publishingServerId is set.

b) Use repo URL defined by distributionManagement from project POM if this is defined.

c) Use Constants.CENTRAL_SNAPSHOTS_URL_DEFAULT_VALUE as default if publishingServerId is set.
  • Type: java.lang.String
  • Since: 0.7.0
  • Required: No
  • User Property: centralSnapshotsUrl

<checksums>

Assign what type of checksums will be generated for files. Three options are available:

all - Will request MD5, SHA1, SHA256 and SHA512 to be generated.

required - Only MD5 and SHA1 will be requested to be generated.

none - No Checksums will be requested to be generated.

  • Type: java.lang.String
  • Since: 0.1.1
  • Required: No
  • User Property: checksums
  • Default: ALL

<deploymentName>

Name of the deployment that's used for uploading and deploying on the central url. If using central.sonatype.com, this is the name that will be visible on the Deployments page.
  • Type: java.lang.String
  • Since: 0.1.1
  • Required: No
  • User Property: deploymentName
  • Default: Deployment

<dropValidated>

Assign whether to drop a deployment in validated state. Meaning that the deployment is deleted after validation succeeded. This configuration is effective only, if autoPublish is not set true. Defaults to Constants.DROP_VALIDATED_DEFAULT_VALUE.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: dropValidated
  • Default: false

<excludeArtifacts>

Assign artifacts that must not be added to the bundle that represents the deployment that will be published.
  • Type: java.util.List<java.lang.String>
  • Since: 0.1.6
  • Required: No
  • User Property: excludeArtifacts

<failOnBuildFailure>

Indicates if building is allowed to have the plugin fail before uploading and publishing occurs.
  • Type: boolean
  • Since: 0.1.1
  • Required: No
  • User Property: failOnBuildFailure
  • Default: true

<forcedDeferredDirectory>

Name of the directory where the plugin will defer snapshot files.
Note: this directory will be cleaned on the first execution of this plugin.
  • Type: java.io.File
  • Since: 0.7.0
  • Required: No
  • User Property: deferredDirectory

<forcedOutputDirectory>

Name of the directory that the plugin will output the bundle file into.
Note: this directory will be cleaned on the first execution of this plugin.
  • Type: java.io.File
  • Since: 0.1.1
  • Required: No
  • User Property: outputDirectory

<forcedStagingDirectory>

Name of the directory where the plugin will stage files.
Note: this directory will be cleaned on the first execution of this plugin.
  • Type: java.io.File
  • Since: 0.1.1
  • Required: No
  • User Property: stagingDirectory

<ignorePublishedComponents>

Assign whether we ignore, or more specifically, not add components that have already been published in the past to the bundle that will be published. When working with projects that are using a multi-module setup, and it's desired to publish only new modules (for example parent, child1 and child2 are all published, and it's desired to publish a new version X.Y.1 of child2, but leave child1 and parent unchanged), this setting will assure that previous published components will not be published again, which will cause the publishing to fail. Defaults to Constants.IGNORE_PUBLISHED_COMPONENTS_DEFAULT_VALUE.
  • Type: boolean
  • Since: 0.1.6
  • Required: No
  • User Property: ignorePublishedComponents
  • Default: false

<outputFilename>

Name of the bundle file that the plugin will output as a result.
  • Type: java.lang.String
  • Since: 0.1.1
  • Required: Yes
  • User Property: outputFilename
  • Default: central-bundle.zip

<publishCompletionPollInterval>

Deprecated.
use waitPollingInterval instead

No description.
  • Type: int
  • Since: 0.1.1
  • Required: No
  • User Property: publishCompletionPollInterval
  • Default: 1000

<publishingServerId>

ID of the server that you configured in your settings.xml.
  • Type: java.lang.String
  • Since: 0.1.1
  • Required: No
  • User Property: publishingServerId
  • Default: central

<skipBundling>

For skipping artifacts bundling. This is particularly useful for multi-module build, where some sub-modules should not be included in the final bundle that will be uploaded to central.sonatype.com.
  • Type: boolean
  • Since: 1.1.0
  • Required: No
  • User Property: skipBundling
  • Default: false

<skipPublishing>

For creating only the bundle but skipping uploading and publishing. This is useful for creating a bundle and manually uploading it through central.sonatype.com.
  • Type: boolean
  • Since: 0.1.1
  • Required: Yes
  • User Property: skipPublishing
  • Default: false

<waitForPublishCompletion>

Deprecated.
use autoPublish in combination with waitUntil instead

No description.
  • Type: boolean
  • Since: 0.1.1
  • Required: No
  • User Property: waitForPublishCompletion
  • Default: false

<waitMaxTime>

Assign the amount of seconds that the plugin will wait for a deployment state. Can not be less than Constants.WAIT_MAX_TIME_DEFAULT_VALUE.
  • Type: int
  • Since: 0.2.0
  • Required: No
  • User Property: waitMaxTime
  • Default: 1800

<waitPollingInterval>

Assign the amount of seconds between checking whether a deployment has published. Can not be less than Constants.WAIT_POLLING_INTERVAL_DEFAULT_VALUE.
  • Type: int
  • Since: 0.2.0
  • Required: No
  • User Property: waitPollingInterval
  • Default: 5

<waitUntil>

Assign what to wait for, if desired to wait, of the processing of a deployment. See @org.sonatype.central.publisher.plugin.model.WaitUntilRequest for options.

uploaded - Wait until the bundle is being uploaded.

validated - Wait until the uploaded bundle is validated.

published - Wait until the uploaded bundle is published to Maven Central.

Defaults to Constants.WAIT_UNTIL_DEFAULT_VALUE.
  • Type: java.lang.String
  • Since: 0.2.0
  • Required: No
  • User Property: waitUntil
  • Default: VALIDATED