|
The latest plugin jar file can be . Download and copy the
build-info-extractor-gradle-<x.y.z>-uber.jar
into your gradle home plugins directory ( ~/.gradle/plugins
).
Then add the following line to your project build script:
buildscript.dependencies.classpath files(new File(gradle.gradleUserHomeDir, 'plugins/build-info-extractor-gradle-<x.y.z>-uber.jar')) |
The Gradle Artifactory plugin is configured using its own Convention DSL inside the build.gradle
script of your root project.
The syntax of the Convention DSL is described below:
We highly recommend also using our as a reference when configuring the DSL in your build scripts.
Mandatory items within the relevant context are prefixed with '+'. All other items are optional. |
artifactory { +contextUrl = 'http://repo.myorg.com/artifactory' //The base Artifactory URL if not overridden by the publisher/resolver publish { contextUrl = 'http://repo.myorg.com/artifactory' //The base Artifactory URL for the publisher //A closure defining publishing information repository { +repoKey = 'integration-libs' //The Artifactory repository key to publish to +username = 'deployer' //The publisher user name password = 'deployerPaS*' //The publisher password ivy { //Optional section for configuring Ivy publication. Assumes Maven repo layout if not specified ivyLayout = '[organization]/[module]/[revision]/[type]s/ivy-[revision].xml' artifactLayout = '[organization]/[module]/[revision]/[module]-[revision](-[classifier]).[ext]' mavenCompatible = true //Convert any dots in an [organization] layout value to path separators, similar to Maven's groupId-to-path conversion. True if not specified } } defaults { //List of Gradle Publications (names or objects) from which to collect the list of artifacts to be deployed to Artifactory. publications ('ivyJava','mavenJava','foo') ////List of Gradle Configurations (names or objects) from which to collect the list of artifacts to be deployed to Artifactory. publishConfigs('archives', 'published') properties = ['qa.level': 'basic', 'q.os': 'win32, deb, osx'] //Optional map of properties to attach to all published artifacts /* The properties closure in the "defaults" task uses the following syntax: properties { publicationName 'group:module:version:classifier@type', key1:'value1', key2:'value2', ... } publicationName: A valid name for a publication of the project. You can use all to apply the properties to all publications. group:module:version:classifier@type: A filter that specifies the artifacts to which properties should be attached. The filter may contain wildcards: * for all characters or ? for a single character. key:'value': A list of key/value properties that will be attached to to the published artifacts matching the filter. */ properties { //Optional closure to attach properties to artifacts based on a list of artifact patterns per project publication foo '*:*:*:*@*', platform: 'linux', 'win64' //The property platform=linux,win64 will be set on all artifacts in foo publication mavenJava 'org.jfrog:*:*:*@*', key1: 'val1' //The property key1=val1 will be set on all artifacts part of the mavenJava publication and with group org.jfrog all 'org.jfrog:shared:1.?:*@*', key2: 'val2', key3: 'val3' //The properties key2 and key3 will be set on all published artifacts (all publications) with group:artifact:version //equal to org.jfrog:shared:1.? } publishBuildInfo = true //Publish build-info to Artifactory (true by default) publishArtifacts = true //Publish artifacts to Artifactory (true by default) publishPom = true //Publish generated POM files to Artifactory (true by default). publishIvy = true //Publish generated Ivy descriptor files to Artifactory (true by default). } } resolve { contextUrl = 'http://repo.myorg.com/artifactory' //The base Artifactory URL for the resolver repository { +repoKey = 'libs-releases' //The Artifactory (preferably virtual) repository key to resolve from username = 'resolver' //Optional resolver user name (leave out to use anonymous resolution) password = 'resolverPaS*' //The resolver password maven = true //Resolve Maven-style artifacts and descriptors (true by default) ivy { //Optional section for configuring Ivy-style resolution. Assumes Maven repo layout if If not specified ivyLayout = ... artifactLayout = ... mavenCompatible = ... } } } // Redefine basic properties of the build info object clientConfig.setIncludeEnvVars(true) clientConfig.setEnvVarsExcludePatterns('*password*,*secret*') clientConfig.setEnvVarsIncludePatterns('*not-secret*') clientConfig.info.addEnvironmentProperty('test.adding.dynVar',new java.util.Date().toString()) clientConfig.info.setBuildName('new-strange-name') clientConfig.info.setBuildNumber('' + new java.util.Random(System.currentTimeMillis()).nextInt(20000)) clientConfig.timeout = 600 // Artifactory connection timeout (in seconds). The default timeout is 300 seconds. } |
As shown in the example above, you can control which environment variables are exposed in |
If you are using the old Gradle publishing mechanism, you need to replace the above defaults closure with the following one: defaults { //This closure defines defaults for all 'artifactoryPublish' tasks of all projects the plugin is applied to publishConfigs ('a','b','foo') //Optional list of configurations (names or objects) to publish. //The 'archives' configuration is used if it exists and no configuration is specified mavenDescriptor = '/home/froggy/projects/proj-a/fly-1.0.pom' //Optional alternative path for a POM to be published (can be relative to project baseDir) ivyDescriptor = 'fly-1.0-ivy.xml' //Optional alternative path for an ivy file to be published (can be relative to project baseDir) properties = ['qa.level': 'basic', 'q.os': 'win32, deb, osx'] //Optional map of properties to attach to all published artifacts /* The properties closure in the "defaults" task uses the following syntax: properties { configuration 'group:module:version:classifier@type', key1:'value1', key2:'value2', ... } configuration: A configuration that is a valid name of a configuration of the project. You can use all to apply the properties to all configurations. group:module:version:classifier@type: An artifact specification filter for matching the artifacts to which properties should be attached. The filter may contain wildcards: * for all characters or ? for a single character. key:'value': A list of key/value(s) properties that are attached to to the published artifacts matching the filter. */ properties { //Optional closure to attach properties to artifacts based on a list of artifact patterns per project configuration foo '*:*:*:*@*', platform: 'linux', 'win64' //The property platform=linux,win64 will be set on all artifacts in foo configuration archives 'org.jfrog:*:*:*@*', key1: 'val1' //The property key1=val1 will be set on all artifacts part of the archives configuration and with group org.jfrog all 'org.jfrog:shared:1.?:*@*', key2: 'val2', key3: 'val3' //The properties key2 and key3 will be set on all published artifacts (all configurations) with group:artifact:version //equal to org.jfrog:shared:1.? } publishBuildInfo = true //Publish build-info to Artifactory (true by default) publishArtifacts = true //Publish artifacts to Artifactory (true by default) publishPom = true //Publish generated POM files to Artifactory (true by default) publishIvy = false //Publish generated Ivy descriptor files to Artifactory (false by default) } |
The Artifactory Publishing Plugin creates an artifactoryPublish
Gradle task for each project the plugin is applied to. The task is configured by the publish
closure of the plugin.
You can configure the project-level task directly with the task's artifactoryPublish
closure, which uses identical Syntax to that of the plugin's publish.defaults
closure.
artifactoryPublish { skip = false //Skip build info analysis and publishing (false by default) contextUrl = 'http://repo.myorg.com/artifactory' publications ('a','b','c') properties = ['qa.level': 'basic', 'q.os': 'win32, deb, osx'] properties { c '**:**:**:*@*', cProperty: 'only in c' } clientConfig.publisher.repoKey = 'integration-libs' clientConfig.publisher.username = 'deployer' clientConfig.publisher.password = 'deployerPaS' } |
The Gradle Artifactory Plugin allows you to define different resolution and publication configuration for sub projects. You may also define the configuration once for the whole project by defining the artifactory closure only in the root project. The plugin also lets you disable publication for a sub-module.
Each sub-project can override either the publish
closure or the resolve
closure, or both of them.
artifactory { publish { contextUrl = 'http://localhost:8081/artifactory' repository { repoKey = "libs-snapshot-local" username = "user" password = "pass" } } } |
artifactory { resolve { contextUrl = 'http://localhost:8081/artifactory' repoKey = 'libs-snapshot' username = "user" password = "pass" } } |
artifactory { contextUrl = 'http://localhost:8081/artifactory' publish { repository { repoKey = "libs-snapshot-local" username = "admin" password = "password" } } resolve { repoKey = 'jcenter' } } |
For buildInfo to be published, a publish closure must be defined in the root project.
artifactoryPublish.skip
flag to deactivate analysis and publication.Activate the corresponding artifactoryPublish
Gradle task manually for each project to which you wish to apply the plugin. For example in our you can run:
./gradlew clean api:artifactoryPublish shared:artifactoryPublish |
Controlling the Build Name and Number
By default, BuildInfo is published with a build name constructed from the name of your root project and a build number that is the start date of the build.
You can control the build name and number values by specifying the following properties respectively:
buildInfo.build.name=my-super-cool-build buildInfo.build.number=r9001 |
The above properties should be added to your project's gradle.properties file.
Project examples which use the Gradle Artifactory Plugin are available .