Creating Better Builds with Gradle
0 likes244 views
This document discusses how to create a Maven-like project structure on top of Gradle builds. It describes the POM and build files used by Maven and Gradle, and how plugins can be used to configure Gradle builds to mimic the standard, two-level, and multi-level project structures supported by Maven. Specific plugins are demonstrated that allow setting the file structure, applying default behaviors from a "Gradle Super POM", and defining a project DSL to configure build properties.
![@aalmiray
TWO-LEVEL (GRADLE)
$ cat settings.gradle
buildscript {
repositories {
gradlePluginPortal()
}
dependencies {
classpath ‘org.kordamp.gradle:settings-gradle-plugin:0.27.0
}
}
apply plugin: 'org.kordamp.gradle.settings'
projects {
layout = 'two-level'
directories = ['docs', 'subprojects']
}](https://image.slidesharecdn.com/creatingbetterbuildswithgradle-191015154409/85/Creating-Better-Builds-with-Gradle-22-320.jpg)
![@aalmiray
MULTI-LEVEL (GRADLE)
$ cat settings.gradle
buildscript {
repositories {
gradlePluginPortal()
}
dependencies {
classpath ‘org.kordamp.gradle:settings-gradle-plugin:0.27.0
}
}
apply plugin: 'org.kordamp.gradle.settings'
projects {
layout = 'multi-level'
directories = [
'guide',
'subprojects/project1',
'subprojects/project2'
]
}](https://image.slidesharecdn.com/creatingbetterbuildswithgradle-191015154409/85/Creating-Better-Builds-with-Gradle-24-320.jpg)
![@aalmiray
THE PROJECT PLUGIN
plugins {
id 'org.kordamp.gradle.project' version ‘0.27.0’
}
config {
release = (rootProject.findProperty('release') ?: false).toBoolean()
info {
name = 'Sample'
vendor = 'Acme'
description = 'Sample project'
links {
website = 'https://github.com/joecool/sample'
issueTracker = 'https://github.com/joecool/sample/issues'
scm = 'https://github.com/joecool/sample.git'
}
people {
person {
id = 'joecool'
name = 'Joe Cool'
roles = ['developer']
}
}
}
…
}](https://image.slidesharecdn.com/creatingbetterbuildswithgradle-191015154409/85/Creating-Better-Builds-with-Gradle-27-320.jpg)
Creating Better Builds with Gradle
- 1. CREATING BETTER BUILDS WITH GRADLE ANDRES ALMIRAY @AALMIRAY
- 2. @aalmiray
- 4. @aalmiray
- 5. @aalmiray POM.XML • POM stands for Project Object Model. • A POM file defines both how a project should be built and how consumers may interact with the published artifacts. • Maven delivers lots of features out of the box thanks to the hierarchical nature of the POM. • The Maven Super POM provides default configuration for common plugins such as compiler, resources, surefire, etc. • The strict nature of the structure found in the POM allows anyone to understand the configuration.
- 6. @aalmiray
- 7. @aalmiray BUILD.GRADLE • Gradle build files only specify how projects should be built. • The definition for consumers is delivered through a generated POM file. • Gradle builds are highly customizable, resulting in a wider range of build patterns.
- 8. CAN WE HAVE A MAVEN-LIKE STRUCTURE ON TOP OF GRADLE?
- 9. HTTP://GITHUB.COM/AALMIRAY/KORDAMP-GRADLE-PLUGINS HTTPS://AALMIRAY.GITHUB.IO/KORDAMP-GRADLE-PLUGINS
- 10. FILE STRUCTURE
- 11. @aalmiray STANDARD (MAVEN) . !"" pom.xml !"" guide # $"" pom.xml !"" project1 # $"" pom.xml $"" project2 $"" pom.xml
- 12. @aalmiray STANDARD (MAVEN) <project> <groupId>com.acme</groupId> <artifactId>parent</artifactId> <version>0.0.0</version> <modules> <module>guide</module> <module>project1</module> <module>project2</module> </modules> </project> <project> <parent> <groupId>com.acme</groupId> <artifactId>parent</ artifactId> <version>0.0.0</version> </parent> </project>
- 13. @aalmiray TWO-LEVEL (MAVEN) . !"" pom.xml !"" docs # $"" guide # $"" pom.xml $"" subprojects !"" project1 # $"" pom.xml $"" project2 $"" pom.xml
- 14. @aalmiray TWO-LEVEL (MAVEN) <project> <groupId>com.acme</groupId> <artifactId>parent</artifactId> <version>0.0.0</version> <modules> <module>docs/guide</module> <module>subprojects/project2</module> <module>subprojects/project3</module> </modules> </project> <project> <parent> <groupId>com.acme</groupId> <artifactId>parent</ artifactId> <version>0.0.0</version> <path>../../pom.xml</path> </parent> </project>
- 15. @aalmiray MULTI-LEVEL (MAVEN) . !"" pom.xml !"" guide # $"" pom.xml $"" subprojects !"" project1 # $"" pom.xml $"" project2 $"" pom.xml
- 16. @aalmiray MULTI-LEVEL (MAVEN) <project> <groupId>com.acme</groupId> <artifactId>parent</artifactId> <version>0.0.0</version> <modules> <module>project1</module> <module>subprojects/project2</module> <module>subprojects/project3</module> </modules> </project> <project> <parent> <groupId>com.acme</groupId> <artifactId>parent</artifactId> <version>0.0.0</version> </parent> </project> <project> <parent> <groupId>com.acme</groupId> <artifactId>parent</artifactId> <version>0.0.0</version> <path>../../pom.xml</path> </parent> </project>
- 17. @aalmiray STANDARD (GRADLE) . !"" build.gradle !"" guide # $"" build.gradle !"" project1 # $"" build.gradle !"" project2 # $"" build.gradle $"" settings.gradle . !"" build.gradle !"" guide # $"" guide.gradle !"" project1 # $"" project1.gradle !"" project2 # $"" project2.gradle $"" settings.gradle
- 18. @aalmiray STANDARD (GRADLE) $ cat settings.gradle include 'guide' include 'project1' include 'project2' $ cat settings.gradle include 'guide' include 'project1' include 'project2’ project(':guide').buildFileName = 'guide.gradle' project(':project1').buildFileName = 'project1.gradle' project(':project2').buildFileName = 'project2.gradle'
- 19. @aalmiray STANDARD (GRADLE) $ cat settings.gradle buildscript { repositories { gradlePluginPortal() } dependencies { classpath ‘org.kordamp.gradle:settings-gradle-plugin:0.27.0 } } apply plugin: 'org.kordamp.gradle.settings' projects { layout = 'standard' }
- 20. @aalmiray TWO-LEVEL (GRADLE) . !"" build.gradle !"" docs # $"" guide # $"" build.gradle $"" subprojects !"" project1 # $"" build.gradle $"" project2 $"" build.gradle . !"" build.gradle !"" docs # $"" guide # $"" guide.gradle $"" subprojects !"" project1 # $"" project1.gradle $"" project2 $"" project2.gradle
- 21. @aalmiray TWO-LEVEL (GRADLE) $ cat settings.gradle include 'guide' include 'project1' include 'project2' project(':guide').projectDir = new File(“$settingsDir/docs/guide”) project(':project1').projectDir = new File(“$settingsDir/subprojects/project1”) project(':project2').projectDir = new File(“$settingsDir/subprojects/project2”)
- 22. @aalmiray TWO-LEVEL (GRADLE) $ cat settings.gradle buildscript { repositories { gradlePluginPortal() } dependencies { classpath ‘org.kordamp.gradle:settings-gradle-plugin:0.27.0 } } apply plugin: 'org.kordamp.gradle.settings' projects { layout = 'two-level' directories = ['docs', 'subprojects'] }
- 23. @aalmiray MULTI-LEVEL (GRADLE) . !"" build.gradle !"" guide # $"" build.gradle $"" subprojects !"" project1 # $"" build.gradle $"" project2 $"" build.gradle . !"" build.gradle !"" guide # $"" guide.gradle $"" subprojects !"" project1 # $"" project1.gradle $"" project2 $"" project2.gradle
- 24. @aalmiray MULTI-LEVEL (GRADLE) $ cat settings.gradle buildscript { repositories { gradlePluginPortal() } dependencies { classpath ‘org.kordamp.gradle:settings-gradle-plugin:0.27.0 } } apply plugin: 'org.kordamp.gradle.settings' projects { layout = 'multi-level' directories = [ 'guide', 'subprojects/project1', 'subprojects/project2' ] }
- 26. PROJECT DSL
- 27. @aalmiray THE PROJECT PLUGIN plugins { id 'org.kordamp.gradle.project' version ‘0.27.0’ } config { release = (rootProject.findProperty('release') ?: false).toBoolean() info { name = 'Sample' vendor = 'Acme' description = 'Sample project' links { website = 'https://github.com/joecool/sample' issueTracker = 'https://github.com/joecool/sample/issues' scm = 'https://github.com/joecool/sample.git' } people { person { id = 'joecool' name = 'Joe Cool' roles = ['developer'] } } } … }
- 28. @aalmiray PROVIDED BEHAVIOR • The project plugin applies the following plugins • org.kordamp.gradle.base • org.kordamp.gradle.build-info • org.kordamp.gradle.minpom • org.kordamp.gradle.jar • org.kordamp.gradle.source-jar • org.kordamp.gradle.javadoc • org.kordamp.gradle.license • org.kordamp.gradle.jacoco • org.kordamp.gradle.publishing • org.kordamp.gradle.testing • org.kordamp.gradle.apidoc • org.kordamp.gradle.source-stats • org.kordamp.gradle.source-html • org.kordamp.gradle.bintray
- 30. @aalmiray ADDITIONAL PLUGINS • The following plugins can be applied explicitly • org.kordamp.gradle.kotlindoc • org.kordamp.gradle.scaladoc • org.kordamp.gradle.source-xref • org.kordamp.gradle.bom • org.kordamp.gradle.clirr • org.kordamp.gradle.guide • org.kordamp.gradle.integration-test • org.kordamp.gradle.functional-test
- 32. SUPER POM
- 33. @aalmiray THE MAVEN SUPER POM • POMs are hierarchical. • The chain resolves all the way to the top where you find the Maven Super POM. • Super POM configures lots of default & useful behavior.
- 34. @aalmiray THE GRADLE SUPER POM • Gradle does not offer this behavior out of the box. • But it can be “faked” using a custom plugin. • The plugin applies the default behavior that consuming projects require.
- 36. @aalmiray
- 38. @aalmiray