Added: dev/commons/commons-release-plugin/1.6-RC1/site/clean-staging-mojo.html ============================================================================== --- dev/commons/commons-release-plugin/1.6-RC1/site/clean-staging-mojo.html (added) +++ dev/commons/commons-release-plugin/1.6-RC1/site/clean-staging-mojo.html Sat Mar 9 13:32:27 2019 @@ -0,0 +1,570 @@ + + + + + + + + + Commons Release Plugin – commons-release:clean-staging + + + + + + + + + + + + + + + + Apache Commons logo + +
+ + + +
+ + + + + +
+ + +
+

commons-release:clean-staging

+ +

Full name:

+ +

org.apache.commons:commons-release-plugin:1.6:clean-staging

+ +

Description:

+ +
This class checks out the dev distribution location, checkes +whether anything exists in the distribution location, and if it is +non-empty it deletes all of the resources there.
+ +

Attributes:

+ +
    + +
  • Requires a Maven project to be executed.
  • + +
  • Executes as an aggregator plugin.
  • + +
  • Since version: 1.6.
  • + +
  • Binds by default to the lifecycle phase: post-clean.
  • +
+ +
+

Required Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeSinceDescription
<project>MavenProject1.6The MavenProject object is essentially the context of +the maven build at a given time.
Default value is: ${project}.
+
+ +
+

Optional Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeSinceDescription
<distCleanupDirectory>File1.6The location to which to checkout the dist subversion repository +under our working directory, which was given above. We then do an +SVN delete on all of the directories in this repository.
Default value is: ${project.build.directory}/commons-release-plugin/scm-cleanup.
User property is: commons.distCleanupDirectory.
<distServer>String1.6The ID of the server (specified in settings.xml) which should be +used for dist authentication. This will be used in preference to +username/password.
User property is: commons.distServer.
<distSvnStagingUrl>String1.6The url of the subversion repository to which we wish the artifacts +to be staged. Typically this would need to be of the form: +scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo/version-RC#. +Note. that the prefix to the substring https is a +requirement.
User property is: commons.distSvnStagingUrl.
<dryRun>Boolean1.6A boolean that determines whether or not we actually commit the +files up to the subversion repository. If this is set to +true, we do all but make the commits. We do checkout +the repository in question though.
Default value is: false.
User property is: commons.release.dryRun.
<isDistModule>Boolean1.6A parameter to generally avoid running unless it is specifically +turned on by the consuming module.
Default value is: false.
User property is: commons.release.isDistModule.
<password>String1.6The password associated with +CommonsDistributionStagingMojo.username.
User property is: user.password.
<username>String1.6The username for the distribution subversion repository. This is +typically your Apache id.
User property is: user.name.
<workingDirectory>File1.6The main working directory for the plugin, namely +target/commons-release-plugin, but that assumes that +we're using the default maven +${project.build.directory}.
Default value is: ${project.build.directory}/commons-release-plugin.
User property is: commons.outputDirectory.
+
+ +
+

Parameter Details

+ +
+

<distCleanupDirectory>

+ +
The location to which to checkout the dist subversion repository +under our working directory, which was given above. We then do an +SVN delete on all of the directories in this repository.
+ +
    + +
  • Type: java.io.File
  • + +
  • Since: 1.6
  • + +
  • Required: No
  • + +
  • User Property: commons.distCleanupDirectory
  • + +
  • Default: ${project.build.directory}/commons-release-plugin/scm-cleanup
  • +

+
+

<distServer>

+ +
The ID of the server (specified in settings.xml) which should be +used for dist authentication. This will be used in preference to +username/password.
+ +
    + +
  • Type: java.lang.String
  • + +
  • Since: 1.6
  • + +
  • Required: No
  • + +
  • User Property: commons.distServer
  • +

+
+

<distSvnStagingUrl>

+ +
The url of the subversion repository to which we wish the artifacts +to be staged. Typically this would need to be of the form: +scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo/version-RC#. +Note. that the prefix to the substring https is a +requirement.
+ +
    + +
  • Type: java.lang.String
  • + +
  • Since: 1.6
  • + +
  • Required: No
  • + +
  • User Property: commons.distSvnStagingUrl
  • +

+
+

<dryRun>

+ +
A boolean that determines whether or not we actually commit the +files up to the subversion repository. If this is set to +true, we do all but make the commits. We do checkout +the repository in question though.
+ +
    + +
  • Type: java.lang.Boolean
  • + +
  • Since: 1.6
  • + +
  • Required: No
  • + +
  • User Property: commons.release.dryRun
  • + +
  • Default: false
  • +

+
+

<isDistModule>

+ +
A parameter to generally avoid running unless it is specifically +turned on by the consuming module.
+ +
    + +
  • Type: java.lang.Boolean
  • + +
  • Since: 1.6
  • + +
  • Required: No
  • + +
  • User Property: commons.release.isDistModule
  • + +
  • Default: false
  • +

+
+

<password>

+ +
The password associated with +CommonsDistributionStagingMojo.username.
+ +
    + +
  • Type: java.lang.String
  • + +
  • Since: 1.6
  • + +
  • Required: No
  • + +
  • User Property: user.password
  • +

+
+

<project>

+ +
The MavenProject object is essentially the context of +the maven build at a given time.
+ +
    + +
  • Type: org.apache.maven.project.MavenProject
  • + +
  • Since: 1.6
  • + +
  • Required: Yes
  • + +
  • Default: ${project}
  • +

+
+

<username>

+ +
The username for the distribution subversion repository. This is +typically your Apache id.
+ +
    + +
  • Type: java.lang.String
  • + +
  • Since: 1.6
  • + +
  • Required: No
  • + +
  • User Property: user.name
  • +

+
+

<workingDirectory>

+ +
The main working directory for the plugin, namely +target/commons-release-plugin, but that assumes that +we're using the default maven +${project.build.directory}.
+ +
    + +
  • Type: java.io.File
  • + +
  • Since: 1.6
  • + +
  • Required: No
  • + +
  • User Property: commons.outputDirectory
  • + +
  • Default: ${project.build.directory}/commons-release-plugin
  • +
+
+
+ + +
+
+ + + + + Added: dev/commons/commons-release-plugin/1.6-RC1/site/clirr-report.html ============================================================================== --- dev/commons/commons-release-plugin/1.6-RC1/site/clirr-report.html (added) +++ dev/commons/commons-release-plugin/1.6-RC1/site/clirr-report.html Sat Mar 9 13:32:27 2019 @@ -0,0 +1,340 @@ + + + + + + + + + Commons Release Plugin – Clirr Results + + + + + + + + + + + + + + + + Apache Commons logo + +
+ + + +
+ + + + + +
+
+

Clirr Results

+

The following document contains the results of Clirr.

+
    +
  • Current Version: 1.6
  • +
  • Comparison Version: 1.5
+
+

Summary

+ + + + + + + + + + + + +
SeverityNumber
Error Error0
Warning Warning0
Info Info2
+
+

API Incompatibilities

+ + + + + + + + + + + + + + + +
SeverityMessageClassMethod / Field
InfoMethod 'public void setAuthentication(org.apache.maven.scm.provider.ScmProviderRepository, java.lang.String, org.apache.maven.settings.Settings, org.apache.maven.settings.crypto.SettingsDecrypter, java.lang.String, java.lang.String)' has been addedorg.apache.commons.release.plugin.SharedFunctionspublic void setAuthentication(org.apache.maven.scm.provider.ScmProviderRepository, java.lang.String, org.apache.maven.settings.Settings, org.apache.maven.settings.crypto.SettingsDecrypter, java.lang.String, java.lang.String)
InfoClass org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo addedorg.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo
+
+

API Changelog

The following APIs were modified from version 1.5 to 1.6: +
    +
  • Non justified changes +

    + + + + + + + + + + + + +
    ClassFromTo
    org.apache.commons.release.plugin.SharedFunctionspublic void setAuthentication(org.apache.maven.scm.provider.ScmProviderRepository, java.lang.String, org.apache.maven.settings.Settings, org.apache.maven.settings.crypto.SettingsDecrypter, java.lang.String, java.lang.String)
    org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo
+
+
+ + + + + Added: dev/commons/commons-release-plugin/1.6-RC1/site/compress-site-mojo.html ============================================================================== --- dev/commons/commons-release-plugin/1.6-RC1/site/compress-site-mojo.html (added) +++ dev/commons/commons-release-plugin/1.6-RC1/site/compress-site-mojo.html Sat Mar 9 13:32:27 2019 @@ -0,0 +1,403 @@ + + + + + + + + + Commons Release Plugin – commons-release:compress-site + + + + + + + + + + + + + + + + Apache Commons logo + +
+ + + +
+ + + + + +
+ + +
+

commons-release:compress-site

+ +

Full name:

+ +

org.apache.commons:commons-release-plugin:1.6:compress-site

+ +

This plugin goal has been deprecated:

+ +
- as we no longer wish to compress the site, we are going to put +this functionality in the +CommonsDistributionStagingMojo.
+ +

Description:

+ +
Takes the built ./target/site directory and compresses +it to ./target/commons-release-plugin/site.zip.
+ +

Attributes:

+ +
    + +
  • Requires a Maven project to be executed.
  • + +
  • Executes as an aggregator plugin.
  • + +
  • Since version: 1.0.
  • + +
  • Binds by default to the lifecycle phase: post-site.
  • +
+ +
+

Optional Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeSinceDescription
<distSvnStagingUrl>String1.0The url of the subversion repository to which we wish the artifacts +to be staged. Typicallly this would need to be of the form: +scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo. +Note. that the prefix to the substring https is a +requirement.
User property is: commons.distSvnStagingUrl.
<isDistModule>Boolean1.0A parameter to generally avoid running unless it is specifically +turned on by the consuming module.
Default value is: false.
User property is: commons.release.isDistModule.
<siteDirectory>File1.0(no description)
Default value is: ${project.build.directory}/site.
User property is: commons.siteOutputDirectory.
<workingDirectory>File1.0The working directory for the plugin which, assuming the maven uses +the default ${project.build.directory}, this becomes +target/commons-release-plugin.
Default value is: ${project.build.directory}/commons-release-plugin.
User property is: commons.outputDirectory.
+
+ +
+

Parameter Details

+ +
+

<distSvnStagingUrl>

+ +
The url of the subversion repository to which we wish the artifacts +to be staged. Typicallly this would need to be of the form: +scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo. +Note. that the prefix to the substring https is a +requirement.
+ +
    + +
  • Type: java.lang.String
  • + +
  • Since: 1.0
  • + +
  • Required: No
  • + +
  • User Property: commons.distSvnStagingUrl
  • +

+
+

<isDistModule>

+ +
A parameter to generally avoid running unless it is specifically +turned on by the consuming module.
+ +
    + +
  • Type: java.lang.Boolean
  • + +
  • Since: 1.0
  • + +
  • Required: No
  • + +
  • User Property: commons.release.isDistModule
  • + +
  • Default: false
  • +

+
+

<siteDirectory>

+ +
(no description)
+ +
    + +
  • Type: java.io.File
  • + +
  • Since: 1.0
  • + +
  • Required: No
  • + +
  • User Property: commons.siteOutputDirectory
  • + +
  • Default: ${project.build.directory}/site
  • +

+
+

<workingDirectory>

+ +
The working directory for the plugin which, assuming the maven uses +the default ${project.build.directory}, this becomes +target/commons-release-plugin.
+ +
    + +
  • Type: java.io.File
  • + +
  • Since: 1.0
  • + +
  • Required: No
  • + +
  • User Property: commons.outputDirectory
  • + +
  • Default: ${project.build.directory}/commons-release-plugin
  • +
+
+
+ + +
+
+ + + + +