Skip to content

Commit 3ff6f69

Browse files
committed
[MSITE-1013] Deprecate and rename SiteStageDeployMojo#stagingRepositoryId to #stagingSiteId
1 parent 1fc3b09 commit 3ff6f69

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

src/main/java/org/apache/maven/plugins/site/deploy/SiteStageDeployMojo.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -63,19 +63,19 @@ public class SiteStageDeployMojo extends AbstractStagingMojo {
6363
private String stagingSiteURL;
6464

6565
/**
66-
* The identifier of the repository where the staging site will be deployed. This id will be used to lookup a
66+
* The identifier of the site where the staged site will be deployed. This id will be used to lookup a
6767
* corresponding <code>&lt;server&gt;</code> entry from the <code>settings.xml</code>. If a matching
6868
* <code>&lt;server&gt;</code> entry is found, its configured credentials will be used for authentication.
6969
* <p/>
7070
* If this is not specified, then the corresponding value of <code>distributionManagement.site.id</code>
7171
* will be taken as default, unless this is not defined either then the String
72-
* <code>"stagingSite"</code> is used. (<strong>Note</strong>:
73-
* until v. 2.3 and 3.0-beta-3 the String <code>"stagingSite"</code> is always used.)
72+
* <code>"stagingSite"</code> is used. Note that the alias {@code stagingRepositoryId} is deprecated
73+
* for removal.
7474
*
7575
* @since 2.0.1
7676
*/
77-
@Parameter(property = "stagingRepositoryId")
78-
private String stagingRepositoryId;
77+
@Parameter(property = "stagingSiteId", alias = "stagingRepositoryId")
78+
private String stagingSiteId;
7979

8080
@Override
8181
protected boolean isDeploy() {
@@ -109,7 +109,7 @@ protected String determineTopDistributionManagementSiteUrl() throws MojoExecutio
109109
protected Site determineDeploySite() throws MojoExecutionException {
110110
Site top = new Site();
111111

112-
top.setId(stagingRepoId());
112+
top.setId(determineStagingSiteId());
113113
getLog().info("Using this server ID for stage deploy: " + top.getId());
114114

115115
String stagingURL = determineStageDeploySiteURL();
@@ -213,9 +213,9 @@ private String determineStageDeploySiteURL() throws MojoExecutionException {
213213
return defaultStagingSiteURL;
214214
}
215215

216-
private String stagingRepoId() {
217-
if (stagingRepositoryId != null) {
218-
return stagingRepositoryId;
216+
private String determineStagingSiteId() {
217+
if (stagingSiteId != null) {
218+
return stagingSiteId;
219219
}
220220

221221
try {

0 commit comments

Comments
 (0)