Andres Almiray - Gradle Ex Machina - Codemotion Rome 2019
•
0 likes•122 views
The Gradle Build Tool is quite powerful and flexible, perhaps too flexible if you ask around. Every where you turn you encounter custom builds with different conventions and arrangements. If only there was a way to follow a structure than ensures top-down constraints in a build. Well it turns out it's possible! Come learn how you and your organization can leverage the powerful features found in the Gradle Build Tool while at the same time reducing clutter and head-scratching moments.
Recommended
More Related Content
What's hot
What's hot (19)
Similar to Andres Almiray - Gradle Ex Machina - Codemotion Rome 2019
Similar to Andres Almiray - Gradle Ex Machina - Codemotion Rome 2019 (20)
More from Codemotion
More from Codemotion (20)
Recently uploaded
Recently uploaded (20)
Andres Almiray - Gradle Ex Machina - Codemotion Rome 2019
- 2. @aalmiray
- 3. @aalmiray
- 4. @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.
- 5. @aalmiray
- 6. @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.
- 7. CAN WE HAVE A MAVEN-LIKE STRUCTURE ON TOP OF GRADLE?
- 8. HTTP://GITHUB.COM/AALMIRAY/KORDAMP-GRADLE-PLUGINS HTTPS://AALMIRAY.GITHUB.IO/KORDAMP-GRADLE-PLUGINS
- 10. @aalmiray STANDARD (MAVEN) . ├── pom.xml ├── guide │ └── pom.xml ├── project1 │ └── pom.xml └── project2 └── pom.xml
- 12. @aalmiray TWO-LEVEL (MAVEN) . ├── pom.xml ├── docs │ └── guide │ └── pom.xml └── subprojects ├── project1 │ └── pom.xml └── project2 └── pom.xml
- 14. @aalmiray MULTI-LEVEL (MAVEN) . ├── pom.xml ├── guide │ └── pom.xml └── subprojects ├── project1 │ └── pom.xml └── project2 └── pom.xml
- 16. @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
- 17. @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'
- 18. @aalmiray STANDARD (GRADLE) $ cat settings.gradle buildscript { repositories { gradlePluginPortal() } dependencies { classpath 'org.kordamp.gradle:settings-gradle-plugin:0.15.0 } } apply plugin: 'org.kordamp.gradle.settings' projects { layout = 'standard' }
- 19. @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
- 20. @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”)
- 21. @aalmiray TWO-LEVEL (GRADLE) $ cat settings.gradle buildscript { repositories { gradlePluginPortal() } dependencies { classpath 'org.kordamp.gradle:settings-gradle-plugin:0.15.0 } } apply plugin: 'org.kordamp.gradle.settings' projects { layout = 'two-level' directories = ['docs', 'subprojects'] }
- 22. @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
- 23. @aalmiray MULTI-LEVEL (GRADLE) $ cat settings.gradle buildscript { repositories { gradlePluginPortal() } dependencies { classpath 'org.kordamp.gradle:settings-gradle-plugin:0.15.0 } } apply plugin: 'org.kordamp.gradle.settings' projects { layout = 'multi-level' directories = [ 'guide', 'subprojects/project1', 'subprojects/project2' ] }
- 24. PROJECT DSL
- 25. @aalmiray THE PROJECT PLUGIN plugins { id 'org.kordamp.gradle.project' version ‘0.15.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'] } } } … }
- 26. @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
- 28. @aalmiray DEFAULT TASKS • Gradle provides the following tasks • projects • dependencies • properties • tasks
- 29. @aalmiray ADDITIONAL TASKS • The base plugin provides the following tasks • extensions • plugins • repositories • projectProperties • effectiveSettings
- 30. @aalmiray
- 31. @aalmiray
- 32. @aalmiray
- 34. @aalmiray BUILD-INFO • The build-info plugin calculates build data such as • Build date • Build time • Build creator • SCM revision (git commit hash) • Build JDK • This information is used to enrich JAR manifests
- 35. @aalmiray JAR MANIFEST EXAMPLE Manifest-Version: 1.0 Created-By: Gradle 5.2 Build-By: aalmiray Build-Jdk: 11 (Oracle Corporation 11+28) Build-Date: 2019-03-22 Build-Time: 06:59:24.924+0100 Build-Revision: 6604da6d0d79f75c72c812f5017cb8d9bb383fb3
- 37. @aalmiray MINPOM • Generates additional metafiles for Maven compatibility • META-INF/maven/${project.group}/pom.properties • META-INF/maven/${project.group}/pom.xml
- 39. @aalmiray JAR • Includes files generated by minpom plugin • Enriches JAR manifest with data from build-info
- 41. @aalmiray SOURCE-JAR • Generates a JAR file with project sources. • Adds the following tasks • sourceJar • artifact is automatically added for publication • aggregateSourceJar
- 43. @aalmiray JAVADOC • Configures Javadoc generation with sensible defaults. • Adds the following tasks • javadoc • javadocJar • artifact is automatically added for publication
- 45. @aalmiray GROOVYDOC • Configures Groovydoc generation with sensible defaults. • Adds the following tasks • groovydoc • groovydocJar • artifact is automatically added for publication
- 47. @aalmiray APIDOC • Configures aggregate doc tasks at root level. • Adds the following tasks • aggregateJavadocs • aggregateJavadocsJar • aggregateGroovydocs • aggregateGroovyDocsJar • aggregateApidocs
- 49. @aalmiray LICENSE • Configures license reports and file header formatting with com.github.hierynomus.license • Adds the following tasks • aggregateLicenseReport
- 51. @aalmiray JACOCO • Configures JaCoCo on all Test tasks. • Adds the following tasks • jacoco<Test>Report • jacocoRootMerge • jacocoRootReport
- 53. @aalmiray SOURCE-HTML • Configures pretty printed API documentation using Java2Html. • Adds the following tasks • convertCodeToHtml • generateSourceHtmlOverview • sourceHtml • aggregateConvertCodeToHtml • aggregateGenerateSourceHtmlOverview • aggregateSourceHtml
- 55. @aalmiray SOURCE-STATS • Generates source statistics based on file types and LOC. • Adds the following tasks • sourceStats • aggregateSourceStats
- 56. @aalmiray SOURCE-STATS > Task :base-gradle-plugin:sourceStats +------------------------+--------+--------+ | Name | Files | LOC | +------------------------+--------+--------+ | Groovy Sources | 55 | 5462 | | Groovy Test Sources | 1 | 102 | | Java Sources | 4 | 43 | +------------------------+--------+--------+ | Totals | 60 | 5607 | +------------------------+--------+--------+
- 58. @aalmiray TESTING • Configures quick feedback test reports. • Adds the following tasks • aggregateTestReports • aggregateIntegrationTestReports • aggregateFunctionalTestReports • aggregateAllTestReports
- 59. @aalmiray
- 61. @aalmiray PUBLISHING • Configures publication of main artifact, including source, javadoc, groovydoc, kotlindoc, scaladoc. • Configures POM based on data from base & license plugins • Artifacts may be optionally signed. • Publication can be deployed to Maven compatible repositories.
- 63. @aalmiray BINTRAY • Configures publication to Bintray based on data provided by base, license, and bintray DSL blocks. • Can push automatically to Maven Central. • Publishes all artifacts registered by publishing plugin.
- 64. @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
- 65. SUPER POM
- 66. @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.
- 67. @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.
- 69. BUILD-SCANS
- 70. @aalmiray X-RAY YOUR BUILDS • Capture build data on the go. • Analyze problems on the spot. • Deep linking enables better sharing. • Works for both Maven and Gradle.
- 73. @aalmiray
- 75. @aalmiray