io.spring.gradle.release.SpringReleasePlugin.groovy Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-release-plugin Show documentation
Show all versions of spring-release-plugin Show documentation
Provides healthy defaults for a Spring release
/*
* Copyright 2017 Pivotal Software, Inc.
*
* 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 io.spring.gradle.release
import nebula.plugin.bintray.NebulaBintrayPublishingPlugin
import nebula.plugin.contacts.ContactsPlugin
import nebula.plugin.info.InfoPlugin
import nebula.plugin.publishing.maven.MavenPublishPlugin
import nebula.plugin.publishing.maven.license.MavenApacheLicensePlugin
import nebula.plugin.publishing.publications.JavadocJarPlugin
import nebula.plugin.publishing.publications.SourceJarPlugin
import nebula.plugin.release.ReleaseExtension
import nebula.plugin.release.ReleasePlugin
import nl.javadude.gradle.plugins.license.License
import nl.javadude.gradle.plugins.license.LicenseExtension
import nl.javadude.gradle.plugins.license.LicensePlugin
import org.ajoberstar.gradle.git.ghpages.GithubPagesPlugin
import org.ajoberstar.gradle.git.release.base.ReleasePluginExtension
import org.ajoberstar.grgit.Grgit
import org.ajoberstar.grgit.operation.OpenOp
import org.asciidoctor.gradle.AsciidoctorPlugin
import org.eclipse.jgit.errors.RepositoryNotFoundException
import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.tasks.javadoc.Javadoc
import org.gradle.api.tasks.testing.Test
import org.slf4j.Logger
import org.slf4j.LoggerFactory
class SpringReleasePlugin implements Plugin {
private static final Logger logger = LoggerFactory.getLogger(SpringReleasePlugin)
private Project project
private String githubOrg
private String githubProject
@Override
void apply(Project project) {
this.project = project
findGithubRemote()
project.with {
// Java
apply plugin: 'java'
repositories {
jcenter()
}
// Publishing
apply plugin: MavenPublishPlugin
apply plugin: MavenApacheLicensePlugin
apply plugin: JavadocJarPlugin
apply plugin: SourceJarPlugin
// Info
apply plugin: InfoPlugin
// Contacts
apply plugin: ContactsPlugin
}
project.tasks.create('downloadDependencies', DownloadDependenciesTask.class)
project.tasks.withType(Javadoc) {
failOnError = false
}
project.tasks.withType(Test) { Test testTask ->
testTask.testLogging.exceptionFormat = 'full'
}
// License
configureLicenseChecks()
// Release
configureRelease()
// Docs
configureDocs()
// CircleCI
project.tasks.create('initCircle', InitCircleTask)
}
private void findGithubRemote() {
try {
Grgit git = new OpenOp(dir: project.rootProject.rootDir).call()
// Remote URLs will be formatted like one of these:
// https://github.com/spring-gradle-plugins/spring-project-plugin.git
// [email protected]:spring-gradle-plugins/spring-release-plugin.git
def repoParts = git.remote.list().collect { it.url =~ /github\.com[\/:]([^\/]+)\/(.+)\.git/ }
.find { it.count == 1 }
if (repoParts == null) {
// no remote configured yet, do nothing
return
}
(githubOrg, githubProject) = repoParts[0].drop(1)
} catch(RepositoryNotFoundException ignored) {
// do nothing
}
}
private void configureRelease() {
if(githubOrg == null) {
logger.warn('No git remote configured, not enabling release related tasks')
return
}
project.with {
apply plugin: ReleasePlugin
if (project == rootProject) {
extensions.findByType(ReleaseExtension)?.with {
addReleaseBranchPattern(/v?\d+\.\d+\.\d+\.RELEASE/)
}
// override nebula's default with a strategy that will add .RELEASE on the end of releases
extensions.findByType(ReleasePluginExtension)?.with {
versionStrategy(new SpringReleaseLastTagStrategy())
versionStrategy(new SpringReleaseFinalStrategy())
}
}
apply plugin: NebulaBintrayPublishingPlugin
bintray.pkg {
repo = 'jars'
userOrg = 'spring'
websiteUrl = "https://github.com/$githubOrg/$githubProject"
vcsUrl = "https://github.com/$githubOrg/${githubProject}.git"
issueTrackerUrl = "https://github.com/$githubOrg/$githubProject/issues"
}
}
}
private void configureLicenseChecks() {
def licenseHeader = project.rootProject.file("gradle/licenseHeader.txt")
def prepareLicenseHeaderTask = project.tasks.create('prepareLicenseHeader') {
doLast {
if (!licenseHeader.exists()) {
licenseHeader.parentFile.mkdirs()
licenseHeader << getClass().getResourceAsStream("/licenseHeader.txt").text
}
}
}
project.with {
apply plugin: LicensePlugin
extensions.findByType(LicenseExtension)?.with {
header = licenseHeader
mapping {
kt = 'JAVADOC_STYLE'
}
sourceSets = project.sourceSets
strictCheck = true
}
}
project.tasks.withType(License) { it.dependsOn prepareLicenseHeaderTask }
}
private void configureDocs() {
File asciidocRoot = project.file('src/docs/asciidoc')
if(asciidocRoot.exists() && project == project.rootProject) {
project.with {
apply plugin: AsciidoctorPlugin
asciidoctorj {
version = '1.5.4'
}
asciidoctor {
attributes 'build-gradle': buildFile,
'source-highlighter':
'coderay',
'imagesdir': 'images',
'toc': 'left',
'icons': 'font',
'setanchors': 'true',
'idprefix': '',
'idseparator': '-',
'docinfo1': 'true'
}
apply plugin: GithubPagesPlugin
publishGhPages.dependsOn asciidoctor
githubPages {
repoUri = "https://github.com/$githubOrg/${githubProject}.git"
credentials {
username = project.hasProperty('githubToken') ? project.githubToken : ''
password = ''
}
pages {
from file(asciidoctor.outputDir.path + '/html5')
}
}
}
}
}
}