Gradle Effective Implementations Guide

Gradle Effective Implementations Guide - Second Edition

By : Hubert Klein Ikkink

Buy this Book

Gradle Effective Implementations Guide - Second Edition

By: Hubert Klein Ikkink

Buy this Book

Overview of this book

Gradle is a project automation tool that has a wide range of applications. The basic aim of Gradle is to automate a wide variety of tasks performed by software developers, including compiling computer source code to binary code, packaging binary codes, running tests, deploying applications to production systems, and creating documentation. The book will start with the fundamentals of Gradle and introduce you to the tools that will be used in further chapters. You will learn to create and work with Gradle scripts and then see how to use Gradle to build your Java Projects. While building Java application, you will find out about other important topics such as dependency management, publishing artifacts, and integrating the application with other JVM languages such as Scala and Groovy. By the end of this book, you will be able to use Gradle in your daily development. Writing tasks, applying plugins, and creating build logic will be your second nature.

Gradle Effective Implementations Guide - Second Edition

Credits

About the Author

About the Reviewer

www.PacktPub.com

Preface

Free Chapter

Starting with Gradle

Declarative builds and convention over configuration

Getting started

Writing our first build script

Default Gradle tasks

Task name abbreviation

Executing multiple tasks

Command-line options

Understanding the Gradle graphical user interface

Summary

Creating Gradle Build Scripts

Writing a build script

Defining tasks

Build scripts are Groovy code

Defining dependencies between tasks

Setting default tasks

Organizing tasks

Adding tasks in other ways

Accessing tasks as project properties

Adding additional properties to tasks

Avoiding common pitfalls

Skipping tasks

Summary

Working with Gradle Build Scripts

Working with files

Project properties

Using logging

Using the Gradle Wrapper

Summary

Using Gradle for Java Projects

Why plugins?

Getting started with the Java plugin

Working with source sets

Working with properties

Creating Javadoc documentation

Summary

Dependency Management

Dependency configuration

Repositories

Defining dependencies

Summary

Testing, Building, and Publishing Artifacts

Testing our projects

Running Java applications

Publishing artifacts

Packaging Java Enterprise Edition applications

Summary

Multi-project Builds

Working with multi-project builds

Working with Java multi-project builds

Using the Jetty plugin

Summary

Mixed Languages

Using the Groovy plugin

Using the Scala plugin

Summary

Maintaining Code Quality

Using the Checkstyle plugin

Using the PMD plugin

Using the FindBugs plugin

Using the JDepend plugin

Using the CodeNarc plugin

Summary

Writing Custom Tasks and Plugins

Creating a custom task

Creating a task in a standalone project

Creating a custom plugin

Creating a plugin in the project source directory

Creating a plugin in a standalone project

Summary

Gradle in the Enterprise

Creating a sample project

Using Jenkins

Using JetBrains TeamCity

Using Atlassian Bamboo

Summary

IDE Support

Using the Eclipse plugin

Using the IntelliJ IDEA plugin

Running Gradle in Eclipse

Running Gradle in IntelliJ IDEA

Summary

Customer Reviews

5 star

4 star

3 star

2 star

1 star

Creating Javadoc documentation

To generate a Javadoc documentation, we must use the javadoc task of the org.gradle.api.tasks.javadoc.Javadoc type. The task generates a documentation for the Java source files in the main source set. If we want to generate documentation for the source sets in our project, we must configure the javadoc task or add an extra javadoc task to our project.

Note that, in our project, we have an API and main source set with the Java source files. If we want to generate documentation for both the source sets, we have to configure the javadoc task in our project. The source property of the javadoc task is set to sourceSets.main.allJava by default. If we add sourceSets.api.allJava to the source property, our interface file is also processed by the javadoc task:

apply plugin: 'java' 
 
javadoc { 
    source sourceSets.api.allJava 
} 
...

Next, we can run the javadoc task and the documentation is generated and put into the build/docs/javadoc...

Gradle Effective Implementations Guide - Second Edition

By : Hubert Klein Ikkink

Gradle Effective Implementations Guide - Second Edition

By: Hubert Klein Ikkink

Overview of this book

Related Content you might be interested in

Current Title:

Gradle Effective Implementations Guide - Second Edition

Creating Javadoc documentation