org.apache.maven.plugins.site.deploy.SiteDeployMojo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven-site-plugin Show documentation

The Maven Site Plugin is a plugin that generates a site for the current project.

There is a newer version: 4.0.0-M16

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.maven.plugins.site.deploy;

import org.apache.maven.model.Site;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Mojo;

/**
 * Deploys the generated site using wagon supported
 * protocols to the site URL specified in the
 * <distributionManagement> section of the POM.
 * 
 * For scp protocol, the website files are packaged by wagon into zip archive,
 * then the archive is transfered to the remote host, next it is un-archived which is much faster
 * than making a file by file copy.
 * 
 *
 * @author Michal Maczka
 *
 * @since 2.0
 */
@Mojo(name = "deploy")
public class SiteDeployMojo extends AbstractDeployMojo {
    @Override
    protected boolean isDeploy() {
        return true;
    }

    /**
     * Deploy distribution site url is directly the current project value.
     */
    @Override
    protected String determineTopDistributionManagementSiteUrl() throws MojoExecutionException {
        return getDeploySite().getUrl();
    }

    /**
     * Deploy directly to the current project's distribution management site.
     */
    @Override
    protected Site determineDeploySite() throws MojoExecutionException {
        return getSite(getTopLevelProject(project));
    }
}