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/01/04 21:21:13 UTC
[maven-release] branch master updated: improve default phases 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 13f65ce improve default phases documentation
13f65ce is described below
commit 13f65cec09fa165a784b0da53b2c5b37184b1cdc
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Tue Jan 4 22:21:10 2022 +0100
improve default phases documentation
---
.../src/main/components-fragment.xml | 15 ++++++++++++
maven-release-manager/src/site/apt/index.apt.vm | 27 ++++++++++++++++++----
.../src/site/apt/examples/branch.apt | 2 +-
.../src/site/apt/examples/perform-release.apt.vm | 2 +-
.../src/site/apt/examples/prepare-release.apt.vm | 2 +-
5 files changed, 40 insertions(+), 8 deletions(-)
diff --git a/maven-release-manager/src/main/components-fragment.xml b/maven-release-manager/src/main/components-fragment.xml
index 6bb0f31..3a36682 100644
--- a/maven-release-manager/src/main/components-fragment.xml
+++ b/maven-release-manager/src/main/components-fragment.xml
@@ -26,7 +26,9 @@
<role-hint>default</role-hint>
<implementation>org.apache.maven.shared.release.strategies.DefaultStrategy</implementation>
<configuration>
+
<preparePhases>
+<!-- START SNIPPET: default-strategy-prepare-phases -->
<phase>check-poms</phase>
<phase>scm-check-modifications</phase>
<phase>check-dependency-snapshots</phase>
@@ -44,18 +46,27 @@
<phase>run-completion-goals</phase>
<phase>scm-commit-development</phase>
<phase>end-release</phase>
+<!-- END SNIPPET: default-strategy-prepare-phases -->
</preparePhases>
+
<performPhases>
+<!-- START SNIPPET: default-strategy-perform-phases -->
<phase>verify-completed-prepare-phases</phase>
<phase>checkout-project-from-scm</phase>
<phase>run-perform-goals</phase>
+<!-- END SNIPPET: default-strategy-perform-phases -->
</performPhases>
+
<rollbackPhases>
+<!-- START SNIPPET: default-strategy-rollback-phases -->
<phase>restore-backup-poms</phase>
<phase>scm-commit-rollback</phase>
<phase>remove-scm-tag</phase>
+<!-- END SNIPPET: default-strategy-rollback-phases -->
</rollbackPhases>
+
<branchPhases>
+<!-- START SNIPPET: default-strategy-branch-phases -->
<phase>check-poms</phase>
<phase>scm-check-modifications</phase>
<phase>create-backup-poms</phase>
@@ -68,12 +79,16 @@
<phase>rewrite-poms-for-development</phase>
<phase>scm-commit-development</phase>
<phase>end-release</phase>
+<!-- END SNIPPET: default-strategy-branch-phases -->
</branchPhases>
+
<updateVersionsPhases>
+<!-- START SNIPPET: default-strategy-update-versions-phases -->
<phase>check-poms-updateversions</phase>
<phase>create-backup-poms</phase>
<phase>map-development-versions</phase>
<phase>rewrite-pom-versions</phase>
+<!-- END SNIPPET: default-strategy-update-versions-phases -->
</updateVersionsPhases>
</configuration>
</component>
diff --git a/maven-release-manager/src/site/apt/index.apt.vm b/maven-release-manager/src/site/apt/index.apt.vm
index a907e5c..f649628 100644
--- a/maven-release-manager/src/site/apt/index.apt.vm
+++ b/maven-release-manager/src/site/apt/index.apt.vm
@@ -30,10 +30,27 @@ Maven Release Manager
* the release management engine ({{{./apidocs/org/apache/maven/shared/release/ReleaseManager.html}ReleaseManager}} API
with {{{./xref/org/apache/maven/shared/release/DefaultReleaseManager.html}DefaultReleaseManager}} implementation),
- * default release phases (in {{{./apidocs/org/apache/maven/shared/release/phase/package-summary.html}phase package}}),
+ * available release phases (in {{{./apidocs/org/apache/maven/shared/release/phase/package-summary.html}phase package}})
+ to be used in {{{./apidocs/org/apache/maven/shared/release/strategies/DefaultStrategy.html}Strategy}} configuration,
- * and the default release strategy ({{{./apidocs/org/apache/maven/shared/release/strategies/DefaultStrategy.html}DefaultStrategy}})
- with its phases configuration:
+ * and the default phases configuration for each release goal:
-%{snippet|id=default-strategy|file=${project.build.sourceDirectory}/../components-fragment.xml}
-
\ No newline at end of file
+ * {<<<prepare>>>}:
+
+%{snippet|id=default-strategy-prepare-phases|file=${project.build.sourceDirectory}/../components-fragment.xml}
+
+ * {<<<perform>>>}:
+
+%{snippet|id=default-strategy-perform-phases|file=${project.build.sourceDirectory}/../components-fragment.xml}
+
+ * {<<<rollback>>>}:
+
+%{snippet|id=default-strategy-rollback-phases|file=${project.build.sourceDirectory}/../components-fragment.xml}
+
+ * {<<<branch>>>}:
+
+%{snippet|id=default-strategy-branch-phases|file=${project.build.sourceDirectory}/../components-fragment.xml}
+
+ * {<<<update-versions>>>}:
+
+%{snippet|id=default-strategy-update-versions-phases|file=${project.build.sourceDirectory}/../components-fragment.xml}
diff --git a/maven-release-plugin/src/site/apt/examples/branch.apt b/maven-release-plugin/src/site/apt/examples/branch.apt
index 00c7b89..98c2d39 100644
--- a/maven-release-plugin/src/site/apt/examples/branch.apt
+++ b/maven-release-plugin/src/site/apt/examples/branch.apt
@@ -25,7 +25,7 @@
Create a Branch
- Creating a branch involves the following release phases:
+ Creating a branch involves the following release phases {{{../maven-release-manager/#branch}by default}}:
* Check that there are no uncommitted changes in the sources
diff --git a/maven-release-plugin/src/site/apt/examples/perform-release.apt.vm b/maven-release-plugin/src/site/apt/examples/perform-release.apt.vm
index 7bf4033..5db4b64 100644
--- a/maven-release-plugin/src/site/apt/examples/perform-release.apt.vm
+++ b/maven-release-plugin/src/site/apt/examples/perform-release.apt.vm
@@ -27,7 +27,7 @@
Perform a Release
- Performing a release runs the following release phases:
+ Performing a release runs the following release phases {{{../maven-release-manager/#perform}by default}}:
* Checkout from an SCM URL with optional tag
diff --git a/maven-release-plugin/src/site/apt/examples/prepare-release.apt.vm b/maven-release-plugin/src/site/apt/examples/prepare-release.apt.vm
index afa9dab..59b9b11 100644
--- a/maven-release-plugin/src/site/apt/examples/prepare-release.apt.vm
+++ b/maven-release-plugin/src/site/apt/examples/prepare-release.apt.vm
@@ -28,7 +28,7 @@
Prepare a Release
- Preparing a release goes through the following release phases:
+ Preparing a release goes through the following release phases {{{../maven-release-manager/#prepare}by default}}:
* Check that there are no uncommitted changes in the sources