Build.gradle: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
 
(75 intermediate revisions by the same user not shown)
Line 1: Line 1:
=External=
=External=
* https://docs.gradle.org/current/userguide/writing_build_scripts.html
* https://docs.gradle.org/current/userguide/writing_build_scripts.html


=Internal=
=Internal=
* [[Gradle_Concepts#Configuration_Scripts_and_Core_Types|Gradle Concepts]]
* [[Gradle Project#Overview|Project]]
=Overview=
build.gradle is referred to as an Gradle build script. It is the script interface to a [[Gradle_Project#Project_API_and_build.gradle_DSL|Project instance]].


* [[Gradle Configuration#build.gradle|Gradle Configuration]]
=Example=
* [[Gradle_Concepts#build.gradle|Gradle Concepts]]
<syntaxhighlight lang='groovy'>


=Overview=
apply plugin: 'java'


The project-level configuration script that contains task configuration for the current project, written in the Gradle's DSL. It tells Gradle what to build. The build script may contain any Groovy language element, including:
// name comes from the directory name or it can be changed in settings.gradle
group = "playground.example"
version = "0.1.0"
description = "A Gradle example project"


* <tt>println</tt>
repositories {
* [[#Variables|variable declarations]]
    mavenLocal()
* [[Gradle_Concepts#Plugin|plugin declarations]]
    mavenCentral()
* [[#Repositories|repositories]]
}


To make build scripts more concise, Gradle automatically adds the set of default Gradle import statements to the script.
dependencies {
    implementation 'org.slf4j:slf4j-api:1.7.12'
    testImplementation 'junit:junit:4.+'
}


=Variables=
configurations {
    testImplementation.exclude group: 'com.example'
}


There are two kinds of variables that can be declared in a build script: local variables and extra properties:
configurations.all {
    resolutionStrategy.cacheChangingModulesFor 3600, 'seconds'
}


==Local Variables==
compileJava {
    options.compilerArgs += ['-Xlint']
}


Local variables, which are a feature of the underlying Groovy language, are declared with the "def" keyword. They are only visible in the scope where they have been declared.
javadoc {
    options.charSet = 'UTF-8'
}


<syntaxhighlight lang='groovy'>
task runMain(type: JavaExec) {
def myVariable = "something"
    classpath = sourceSets.main.runtimeClasspath
...
    main = "io.novaordis.playground.gradle.java.Main"
println myVariable
}
</syntaxhighlight>
</syntaxhighlight>


==Extra Properties==
=Comments=
 
[[Gradle_Properties#Extra_Properties|Extra properties]] can be declared as follows:


<syntaxhighlight lang='groovy'>
<syntaxhighlight lang='groovy'>
...
// This is a comment
ext {
    log4jVersion = "2.1.7"
    emailNotification = "build@example.com"
}
...
</syntaxhighlight>
</syntaxhighlight>


=DSL=
=Code=
 
The build script may include general-purpose Java and Groovy code:
<syntaxhighlight lang='groovy'>


==<span id='Repositories'></span>repositories==
class Experimental {


[[Gradle Concepts#Repository|Repositories]] are declared in a 'repositories' block:
    private String name;


<syntaxhighlight lang='groovy'>
    Experimental(String name) {
repositories {
}
</syntaxhighlight>


Multiple repositories can be declared in the same block. Syntax examples are available for [[Gradle_Concepts#Custom_Maven_Repository|custom Maven repositories]], [[Gradle_Concepts#flatDir|directory-based repositories]], [[Gradle_Concepts#Maven_Central|Maven Central]], etc.
        this.name = name;
    }


==buildscript==
    @Override
    public String toString() {
        return name;
    }
}


Used when [[Gradle Concepts#External_Plugins|external plugins]] need to be downloaded.
def experimental = new Experimental("blue");


<syntaxhighlight lang='groovy'>
task test {
buildscript {
     doLast {
     repositories {
         println experimental
         maven { url 'https://plugins.gradle.org/m2/' }
     }
     }
  dependencies {
}
    classpath 'com.netflix.nebula:gradle-ospackage-plugin:4.3.0'
</syntaxhighlight>
  }
}</syntaxhighlight>

Latest revision as of 22:10, 11 October 2020

External

Internal

Overview

build.gradle is referred to as an Gradle build script. It is the script interface to a Project instance.

Example

apply plugin: 'java'

// name comes from the directory name or it can be changed in settings.gradle
group = "playground.example"
version = "0.1.0"
description = "A Gradle example project"

repositories {
    mavenLocal()
    mavenCentral()
}

dependencies {
    implementation 'org.slf4j:slf4j-api:1.7.12'
    testImplementation 'junit:junit:4.+'
}

configurations {
    testImplementation.exclude group: 'com.example'
}

configurations.all {
    resolutionStrategy.cacheChangingModulesFor 3600, 'seconds'
}

compileJava {
    options.compilerArgs += ['-Xlint']
}

javadoc {
    options.charSet = 'UTF-8'
}

task runMain(type: JavaExec) {
    classpath = sourceSets.main.runtimeClasspath
    main = "io.novaordis.playground.gradle.java.Main"
}

Comments

// This is a comment

Code

The build script may include general-purpose Java and Groovy code: 

class Experimental {

    private String name;

    Experimental(String name) {

        this.name = name;
    }

    @Override
    public String toString() {
        return name;
    }
}

def experimental = new Experimental("blue");

task test {
    doLast {
        println experimental
    }
}
Retrieved from "https://kb.novaordis.com/index.php?title=Build.gradle&oldid=71404"