You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2022/05/08 15:43:58 UTC
[maven-release] branch master updated: improve documentation
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-release.git
The following commit(s) were added to refs/heads/master by this push:
new 3445ec12 improve documentation
3445ec12 is described below
commit 3445ec12392b96c59c71f5614576c25d83844f6e
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Sun May 8 17:43:55 2022 +0200
improve documentation
---
.../release/phase/AbstractRunGoalsPhase.java | 7 +++---
.../shared/release/phase/RunPerformGoalsPhase.java | 6 +++--
.../shared/release/phase/RunPrepareGoalsPhase.java | 2 +-
maven-release-plugin/src/site/site.xml | 12 +++++++++-
release.properties | 27 ++++++++++++++++++++++
5 files changed, 47 insertions(+), 7 deletions(-)
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRunGoalsPhase.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRunGoalsPhase.java
index 12ba401d..ec45e788 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRunGoalsPhase.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRunGoalsPhase.java
@@ -33,7 +33,7 @@ import org.codehaus.plexus.util.StringUtils;
import static java.util.Objects.requireNonNull;
/**
- * Run the integration tests for the project to verify that it builds before committing.
+ * Abstract phase to run a Maven invocation on the project.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
*/
@@ -50,8 +50,8 @@ public abstract class AbstractRunGoalsPhase
this.mavenExecutors = requireNonNull( mavenExecutors );
}
- public ReleaseResult execute( ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment,
- File workingDirectory, String additionalArguments )
+ protected ReleaseResult execute( ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment,
+ File workingDirectory, String additionalArguments )
throws ReleaseExecutionException
{
ReleaseResult result = new ReleaseResult();
@@ -62,6 +62,7 @@ public abstract class AbstractRunGoalsPhase
if ( !StringUtils.isEmpty( goals ) )
{
logInfo( result, "Executing goals '" + goals + "'..." );
+ // TODO add additionalArguments?
MavenExecutor mavenExecutor = mavenExecutors.get( releaseEnvironment.getMavenExecutorId() );
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RunPerformGoalsPhase.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RunPerformGoalsPhase.java
index 0be778a6..40cc1feb 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RunPerformGoalsPhase.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RunPerformGoalsPhase.java
@@ -37,7 +37,7 @@ import org.apache.maven.shared.release.util.PomFinder;
import org.codehaus.plexus.util.StringUtils;
/**
- * Run the integration tests for the project to verify that it builds before committing.
+ * Run the effective release build of the project and its deploy to remote repository.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
*/
@@ -100,8 +100,10 @@ public class RunPerformGoalsPhase
ReleaseResult result = new ReleaseResult();
logDebug( result, "Additional arguments: " + additionalArguments );
+ // TODO switch to Info?
- logInfo( result, "Executing perform goals - since this is simulation mode these goals are skipped." );
+ logInfo( result, "Executing perform goals '" + getGoals( releaseDescriptor )
+ + "' - since this is simulation mode these goals are skipped." );
return result;
}
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RunPrepareGoalsPhase.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RunPrepareGoalsPhase.java
index 4313ec61..a208c3e9 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RunPrepareGoalsPhase.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RunPrepareGoalsPhase.java
@@ -35,7 +35,7 @@ import org.apache.maven.shared.release.env.ReleaseEnvironment;
import org.apache.maven.shared.release.exec.MavenExecutor;
/**
- * Run the integration tests for the project to verify that it builds before committing.
+ * Run a build of the project (eventually with the integration tests) to verify that it builds before committing.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
*/
diff --git a/maven-release-plugin/src/site/site.xml b/maven-release-plugin/src/site/site.xml
index 67d10dc3..5858309d 100644
--- a/maven-release-plugin/src/site/site.xml
+++ b/maven-release-plugin/src/site/site.xml
@@ -32,7 +32,17 @@ under the License.
</breadcrumbs>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="Goals" href="plugin-info.html"/>
+ <item name="Goals" href="plugin-info.html" collapse="true">
+ <item name="clean" href="clean-mojo.html"/>
+ <item name="prepare" href="prepare-mojo.html"/>
+ <item name="prepare-with-pom" href="prepare-with-pom-mojo.html"/>
+ <item name="rollback" href="rollback-mojo.html"/>
+ <item name="perform" href="perform-mojo.html"/>
+ <item name="stage" href="stage-mojo.html"/>
+ <item name="branch" href="branch-mojo.html"/>
+ <item name="update-versions" href="update-versions-mojo.html"/>
+ <item name="help" href="help-mojo.html"/>
+ </item>
<item name="Usage" href="usage.html"/>
<item name="Upgrade" href="upgrade.html"/>
<item name="FAQ" href="faq.html"/>
diff --git a/release.properties b/release.properties
new file mode 100644
index 00000000..bf54b52a
--- /dev/null
+++ b/release.properties
@@ -0,0 +1,27 @@
+#release configuration
+#Sun May 08 16:33:56 CEST 2022
+scm.commentPrefix=[maven-release-plugin]
+exec.pomFileName=pom.xml
+pushChanges=true
+releaseStrategyId=default
+project.scm.org.apache.maven.release\:maven-release.url=https\://github.com/apache/maven-release/tree/${project.scm.tag}
+project.scm.org.apache.maven.release\:maven-release-semver-policy.empty=true
+remoteTagging=true
+scm.branchCommitComment=@{prefix} prepare branch @{releaseLabel}
+project.scm.org.apache.maven.release\:maven-release-oddeven-policy.empty=true
+project.scm.org.apache.maven.plugins\:maven-release-plugin.empty=true
+projectVersionPolicyId=default
+project.scm.org.apache.maven.release\:maven-release.connection=scm\:git\:https\://gitbox.apache.org/repos/asf/maven-release.git
+scm.url=scm\:git\:https\://gitbox.apache.org/repos/asf/maven-release.git
+scm.tagNameFormat=@{project.artifactId}-@{project.version}
+project.scm.org.apache.maven.release\:maven-release.developerConnection=scm\:git\:https\://gitbox.apache.org/repos/asf/maven-release.git
+pinExternals=false
+preparationGoals=clean verify
+scm.releaseCommitComment=@{prefix} prepare release @{releaseLabel}
+exec.snapshotReleasePluginAllowed=false
+scm.developmentCommitComment=@{prefix} prepare for next development iteration
+scm.rollbackCommitComment=@{prefix} rollback the release of @{releaseLabel}
+project.scm.org.apache.maven.release\:maven-release.tag=HEAD
+completedPhase=check-poms
+project.scm.org.apache.maven.release\:maven-release-manager.empty=true
+project.scm.org.apache.maven.release\:maven-release-api.empty=true