org.ajoberstar.gradle.git.release.base.BaseReleasePlugin.groovy Maven / Gradle / Ivy
/*
* Copyright 2012-2015 the original author or authors.
*
* Licensed 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.ajoberstar.gradle.git.release.base
import org.gradle.api.GradleException
import org.gradle.api.Plugin
import org.gradle.api.Project
import org.slf4j.Logger
import org.slf4j.LoggerFactory
/**
* Plugin providing the base structure of gradle-git's flavor of release
* behavior. The plugin can be applied using the {@code org.ajoberstar.release-base} id.
*
*
* The plugin adds the {@link ReleasePluginExtension} and a {@code release} task.
*
*
* @see org.ajoberstar.gradle.git.release.opinion.Strategies
* @see org.ajoberstar.gradle.git.release.opinion.OpinionReleasePlugin
* @see Wiki Doc
*/
class BaseReleasePlugin implements Plugin {
private static final Logger logger = LoggerFactory.getLogger(BaseReleasePlugin)
private static final String PREPARE_TASK_NAME = 'prepare'
private static final String RELEASE_TASK_NAME = 'release'
void apply(Project project) {
def extension = project.extensions.create('release', ReleasePluginExtension, project)
addPrepareTask(project, extension)
addReleaseTask(project, extension)
}
private void addPrepareTask(Project project, ReleasePluginExtension extension) {
project.tasks.create(PREPARE_TASK_NAME) {
description = 'Verifies that the project could be released.'
doLast {
ext.grgit = extension.grgit
logger.info('Fetching changes from remote: {}', extension.remote)
grgit.fetch(remote: extension.remote)
if (grgit.branch.status(branch: grgit.branch.current.fullName).behindCount > 0) {
throw new GradleException('Current branch is behind the tracked branch. Cannot release.')
}
}
}
project.tasks.all { task ->
if (name != PREPARE_TASK_NAME) {
task.shouldRunAfter PREPARE_TASK_NAME
}
}
}
private void addReleaseTask(Project project, ReleasePluginExtension extension) {
project.tasks.create(RELEASE_TASK_NAME) {
description = 'Releases this project.'
dependsOn PREPARE_TASK_NAME
doLast {
// force version inference if it hasn't happened already
project.version.toString()
ext.grgit = extension.grgit
ext.toPush = [grgit.branch.current.fullName]
ext.tagName = extension.tagStrategy.maybeCreateTag(grgit, project.version.inferredVersion)
if (tagName) {
toPush << tagName
}
logger.warn('Pushing changes in {} to {}', toPush, extension.remote)
grgit.push(remote: extension.remote, refsOrSpecs: toPush)
}
}
}
}