org.eclipse.tycho.versions.SetMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tycho-versions-plugin
There is a newer version: 3.0.5
/*******************************************************************************
 * Copyright (c) 2008, 2015 Sonatype Inc. and others.
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *    Sonatype Inc. - initial API and implementation
 *    Sebastien Arod - update version ranges
 *******************************************************************************/
package org.eclipse.tycho.versions;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.StringTokenizer;

import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.eclipse.tycho.versions.engine.ProjectMetadataReader;
import org.eclipse.tycho.versions.engine.VersionsEngine;

/**
 * 
 * Sets the version of the current project and child projects with the same version, and updates
 * references as necessary.
 * 
 * 
 * The set-version goal implements a version refactoring for a Tycho reactor: When updating the
 * version of a project, it consistently updates the version strings in the project's configuration
 * files (e.g. pom.xml and META-INF/MANIFEST.MF) and all references to that project (e.g. in a
 * feature.xml).
 * 
 * 
 * In many cases, the set-version goal changes the version of multiple projects or entities at once.
 * In addition to the current project, child projects with the same version are also changed. The
 * set of version changes is determined according to the following rules:
 * 
 * 
 * When the parent project of a project is changed and the project has the same version as the
 * parent project, the project is also changed.
 * When an eclipse-plugin project is changed and the plugin exports a package with a
 * version which is the same as the unqualified project version, the version of the package is also
 * changed.
 * 
Require-Bundle and Fragment-Host Version Range in references to an eclipse-plugin
 * that changed version will be updated:
 * 
 * if the newVersion becomes out of the original VersionRange
 * 
or if {@link #updateVersionRangeMatchingBounds} is true and one of the bounds is matching the
 * original version
 * 
 * 
When an eclipse-repository project is changed and a product file in the project has
 * an equivalent version, the version in the product file is also changed.
 * 
 * 
 */
@Mojo(name = "set-version", aggregator = true, requiresDirectInvocation = true)
public class SetMojo extends AbstractMojo {
    /**
     * 
     * The new version to set to the current project and other entities which have the same version
     * as the current project.
     * 
     */
    @Parameter(property = "newVersion", required = true, alias = "developmentVersion")
    private String newVersion;

    /**
     * 
     * Initial list of of projects to be changed. From these projects, the full list of projects to
     * be changed is derived according to the rules described above. If set, this parameter needs to
     * be specified as a comma separated list of artifactIds.
     * 
     */
    @Parameter(property = "artifacts", defaultValue = "${project.artifactId}")
    private String artifacts;

    /**
     * 
     * When true bounds of OSGI version ranges referencing the version of an element that changed
     * version will be updated to match the newVersion.
     * 
     */
    @Parameter(property = "updateVersionRangeMatchingBounds", defaultValue = "false")
    private boolean updateVersionRangeMatchingBounds;

    /**
     * 
     * Comma separated list of names of POM properties to set the new version to. Note that
     * properties are only changed in the projects explicitly listed by the {@link #artifacts}
     * parameter.
     * 
     * 
     * @since 0.18.0
     */
    @Parameter(property = "properties")
    private String properties;

    @Component
    private VersionsEngine engine;

    @Parameter(property = "session", readonly = true)
    private MavenSession session;

    @Component
    private ProjectMetadataReader metadataReader;

    @Override
    public void execute() throws MojoExecutionException, MojoFailureException {
        if (newVersion == null || newVersion.isEmpty()) {
            throw new MojoExecutionException("Missing required parameter newVersion");
        }

        engine.setUpdateVersionRangeMatchingBounds(updateVersionRangeMatchingBounds);

        try {
            metadataReader.addBasedir(session.getCurrentProject().getBasedir());

            engine.setProjects(metadataReader.getProjects());

            // initial changes
            for (String artifactId : split(artifacts)) {
                engine.addVersionChange(artifactId, newVersion);
                for (String propertyName : split(properties)) {
                    engine.addPropertyChange(artifactId, propertyName, newVersion);
                }
            }

            engine.apply();
        } catch (IOException e) {
            throw new MojoExecutionException("Could not set version", e);
        }
    }

    private static List split(String str) {
        ArrayList result = new ArrayList<>();
        if (str != null) {
            StringTokenizer st = new StringTokenizer(str, ",");
            while (st.hasMoreTokens()) {
                result.add(st.nextToken().trim());
            }
        }
        return result;
    }
}