org.kuali.maven.plugins.jenkins.RunJobMojo Maven / Gradle / Ivy

Go to download

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

Automated management of Jenkins jobs via Maven. Much of the information needed by Jenkins when creating a job is already in the Maven pom. The SCM information and CI url are present. Jenkins jobs also typically have names that reflect the groupId, artifactId, and version in some manner. This plugin automates the process of creating Jenkins jobs by harvesting information from the POM to create XML config files in the format Jenkins needs. The Jenkins CLI API is then used to create, update, read, and delete Jenkins jobs on the CI server. If your Jenkins instance requires authentication, add your public key to your user account on the Jenkins server.

There is a newer version: 1.2.8

Show newest version

/**
 * Copyright 2011-2013 The Kuali Foundation
 *
 * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
 *
 * 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.kuali.maven.plugins.jenkins;

import java.util.Map;

/**
 * Connect to a Jenkins server and kick off a job
 *
 * @goal runjob
 * @threadSafe
 * @requiresDependencyResolution test
 */
public class RunJobMojo extends SimpleJobMojo {

	/**
	 * The Jenkins CLI command for running a job
	 *
	 * @parameter expression="${jenkins.cmd}" default-value="build"
	 * @required
	 */
	private String cmd;

	/**
	 * If true, wait for the job to complete before continuing.
	 *
	 * @parameter expression="${jenkins.wait}" default-value="true"
	 * @required
	 */
	private boolean wait;

	/**
	 * If true, check for changes before running the job. If nothing has changed, do not run the job.
	 *
	 * @parameter expression="${jenkins.skipIfNoChanges}" default-value="false"
	 * @required
	 */
	private boolean skipIfNoChanges;

	/**
	 * Comma delimited list of key=value pairs to pass to the Jenkins job as build parameters
	 *
	 * @parameter expression="${jenkins.params}"
	 */
	private String params;

	/**
	 * key=value pairs to pass to the Jenkins job as build parameters
	 *
	 * @parameter
	 */
	private Map paramMap;

	@Override
	protected void executeMojo() {
		helper.execute(this);
	}

	public boolean isWait() {
		return wait;
	}

	public void setWait(boolean wait) {
		this.wait = wait;
	}

	public boolean isSkipIfNoChanges() {
		return skipIfNoChanges;
	}

	public void setSkipIfNoChanges(boolean skipIfNoChanges) {
		this.skipIfNoChanges = skipIfNoChanges;
	}

	public Map getParamMap() {
		return paramMap;
	}

	public void setParamMap(Map paramMap) {
		this.paramMap = paramMap;
	}

	public String getParams() {
		return params;
	}

	public void setParams(String params) {
		this.params = params;
	}

	@Override
	public String getCmd() {
		return cmd;
	}

	public void setCmd(String cmd) {
		this.cmd = cmd;
	}

}