Gradle Effective Implementation Guide

Gradle Effective Implementation Guide

Overview of this book

Gradle is the next generation in build automation. It uses convention-over-configuration to provide good defaults, but is also flexible enough to be usable in every situation you encounter in daily development. Build logic is described with a powerful DSL and empowers developers to create reusable and maintainable build logic."Gradle Effective Implementation Guide" is a great introduction and reference for using Gradle. The Gradle build language is explained with hands on code and practical applications. You learn how to apply Gradle in your Java, Scala or Groovy projects, integrate with your favorite IDE and how to integrate with well-known continuous integration servers.Start with the foundations and work your way through hands on examples to build your knowledge of Gradle to skyscraper heights. You will quickly learn the basics of Gradle, how to write tasks, work with files and how to use write build scripts using the Groovy DSL. Then as you develop you will be shown how to use Gradle for Java projects. Compile, package, test and deploy your applications with ease. When you've mastered the simple, move on to the sublime and integrate your code with continuous integration servers and IDEs. By the end of the "Gradle Effective Implementation Guide" you will be able to use Gradle in your daily development. Writing tasks, applying plugins and creating build logic will be second nature.

Gradle Effective Implementation Guide

Credits

About the Author

Acknowledgement

About the Reviewers

www.PacktPub.com

Preface

Free Chapter

Starting with Gradle

Introducing Gradle

Getting started

Writing our first build script

Default Gradle tasks

Task name abbreviation

Executing multiple tasks

Command-line options

Understanding the Gradle 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

Using plugins

Getting started

Using the Java plugin

Working with source sets

Working with properties

Creating documentation

Assembling archives

Summary

Dependency Management

Dependency configuration

Repositories

Defining dependencies

Summary

Testing, Building, and Publishing Artifacts

Testing

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

Using the Sonar plugin

Summary

Writing Custom Tasks and Plugins

Creating a custom task

Creating a task in the project source directory

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

Using Gradle with Continuous Integration

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

Index

Customer Reviews

5 star

4 star

3 star

2 star

1 star

Creating documentation

To generate Javadoc documentation, we must use the javadoc task that is of type org.gradle.api.tasks.javadoc.Javadoc. The task generates 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, by default, set to sourceSets.main.allJava. 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 directory:

$ gradle javadoc
:compileApiJava...

Gradle Effective Implementation Guide

Gradle Effective Implementation Guide

Overview of this book

Related Content you might be interested in

Current Title:

Gradle Effective Implementation Guide

Creating documentation