Gradle - include properties file

Question

How to include a properties file in Gradle?

For example, in Ant, I could do the following:

<property file="${basedir}/build.properties" /> 

Answer 1

You can do this using java syntax, for example:

 Properties props = new Properties() InputStream in = new FileInputStream("/path/file.properties") props.load(in) in.close() 

This should work in any groovy script. Perhaps there is a more “groovy” way using a closure or other bright shortcut.

Answer 2

I would recommend using the default Gradle properties file. If you put the properties in gradle.properties in the same directory as build.gradle , they will be automatically available.

See user manual .

Answer 3

What you are looking for is similar to:

  Properties props = new Properties() props.load(new FileInputStream("$project.rootDir/profile/"+"$environment"+".properties")) props.each { prop -> project.ext.set(prop.key, prop.value) } 

Then your properties should be available directly through their name. I.e:.

  println "$jdbcURL" println project.jdbcURL 

Perhaps the reason (shadowy?) Is why its a bad idea to do this? Not sure why it is not supported out of the box or can be found somewhere else.

Answer 4

This is how I include the CSV file in my .jar, which is Gradle builds:

 sourceSets { main { java { srcDir 'src/main/java' output.classesDir = 'build/classes/main' } resources { srcDir 'src/main/resources' include '*.csv' output.resourcesDir = 'build/resources/main' } } } 

Then, when my application loads the resource, this is done regardless of Gradle.

Answer 5

For Gradle 1.x (deprecated in Gradle 2.x)

To include your .properties file, you can simply use something like this:

  apply from: "version.properties" 

what is it!

Answer 6

Use the env variable for GRADLE_USER_HOME to set the gradle home directory. Place the gradle.properties file and set the parameters.

https://docs.gradle.org/current/userguide/build_environment.html

The properties file in the user's home directory takes precedence over the properties files in the project directories.

Answer 7

I really missed this Ant function, especially the replacement of properties, for example work.dir=${basedir}/work . With some of the large assemblies that I work with that perform many environment settings for automated tests, there are some tasks that require only custom user and environment settings. Simple "gradle.properties" is simply not enough, especially for parameters that are shared between several projects.

I have compiled an example gradle file that controls a reasonable scheme for loading properties: load-properties.gradle . This allows the project to pinpoint the properties that it uses in the default-properties.gradle file, and allows users to define their local settings to override them. Since the read property files are gradle scripts, you can include additional logic in them, and the values ​​are not limited to just strings.

In addition, it allows you to define a properties file for each environment (for example, "mac" or "jenkins-machine" or "remote"), passing the parameter "-Penv = (env name)" to gradle.

Answer 8

The accepted answer works if you do not want to add properties to the project, since this is the first search result, I will add my solution, which works in gradle 3.x. An easy way to do this is through ant.

 ant { property(file: 'properties.file') } 

If you need to convert the property in Camel Case for easy access to your script (remember that the point-based syntax of the points and the actual object exist in gradle):

 println "property value:{dot.property.from.file}" //this will fail. def camelCaseProperty = project.getProperties().get("dot.property.from.file") println "camelCaseProperty:${camelCaseProperty}" //this wont fail 

If you need a default if not specified:

 def propertyWithDefault = project.getProperties().get("dot.property.from.file","defaultValue"); 

Using this method, at least with IntelliJ / Android Studio, the IDE will link your properties file and gradle script and add completion, link checking, etc.