Usage
The Maven Artifactory Plugin coordinates are org.jfrog.buildinfo:artifactory-maven-plugin:2.6.1. It can be viewed on
Bintray, and can be download via the
JCenter Repository.
A typical build plugin configuration would be as follows:
<build>
<plugins>
...
<plugin>
<groupId>org.jfrog.buildinfo</groupId>
<artifactId>artifactory-maven-plugin</artifactId>
<version>2.6.1</version>
<inherited>false</inherited>
<executions>
<execution>
<id>build-info</id>
<goals>
<goal>publish</goal>
</goals>
<configuration>
<deployProperties>
<gradle>awesome</gradle>
<review.team>qa</review.team>
</deployProperties>
<publisher>
<contextUrl>https://oss.jfrog.org</contextUrl>
<username>deployer</username>
<password>{DESede}...</password>
<repoKey>libs-release-local</repoKey>
<snapshotRepoKey>libs-snapshot-local</snapshotRepoKey>
</publisher>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
The plugin's invocation phase is validate by default and we recommend you don't change it so the plugin is called as early as possible in the lifecycle of your Maven build.
Configuration
The example above configures the Artifactory publisher, to deploy build artifacts either to the releases or the snapshots repository of the
public OSS instance of Artifactory when mvn deploy is executed.
However, the Maven Artifactory Plugin provides many other configurations which you can see by running mvn -X validate and are displayed below:
<deployProperties> .. </deployProperties> <artifactory> <envVarsExcludePatterns> .. </envVarsExcludePatterns> <envVarsIncludePatterns> .. </envVarsIncludePatterns> <includeEnvVars>true/false</includeEnvVars> <timeoutSec>N</timeoutSec> </artifactory> <publisher> <contextUrl> .. </contextUrl> <username> .. </username> <password> .. </password> <repoKey> .. </repoKey> <snapshotRepoKey> .. </snapshotRepoKey> <publishArtifacts>true/false</publishArtifacts> <publishBuildInfo>true/false</publishBuildInfo> <excludePatterns> .. </excludePatterns> <includePatterns> .. </includePatterns> <filterExcludedArtifactsFromBuild>true/false</filterExcludedArtifactsFromBuild> <!-- If true build information published to Artifactory will include implicit project as well as build-time dependencies --> <recordAllDependencies>true/false</recordAllDependencies> </publisher> <buildInfo> <agentName> .. </agentName> <agentVersion> .. </agentVersion> <buildName> .. </buildName> <buildNumber> .. </buildNumber> <buildNumbersNotToDelete> .. </buildNumbersNotToDelete> <buildRetentionMaxDays>N</buildRetentionMaxDays> <buildRetentionCount>N</buildRetentionCount> <buildUrl> .. </buildUrl> <principal> .. </principal> <vcsRevision> .. </vcsRevision> </buildInfo> <licenses> <autoDiscover>true/false</autoDiscover> <includePublishedArtifacts>true/false</includePublishedArtifacts> <runChecks>true/false</runChecks> <scopes> .. </scopes> <violationRecipients> .. </violationRecipients> </licenses> <blackDuck> <appName> .. </appName> <appVersion> .. </appVersion> <autoCreateMissingComponentRequests>true/false</autoCreateMissingComponentRequests> <autoDiscardStaleComponentRequests>true/false</autoDiscardStaleComponentRequests> <includePublishedArtifacts>true/false</includePublishedArtifacts> <reportRecipients> .. </reportRecipients> <scopes> .. </scopes> </blackDuck>
| Specifies properties you can attach to published artifacts. For example: <deployProperties>
<groupId>${project.groupId}</groupId>
<artifactId>${project.artifactId}</artifactId>
<version>${project.version}</version>
</deployProperties>
|
| Specifies whether environment variables are published as part of BuildInfo metadata and which include or exclude patterns are applied when variables are collected |
| Defines an Artifactory repository where build artifacts should be published using a combination of a Build artifacts are deployed if the |
| Updates BuildInfo metadata published together with build artifacts. You can configure whether or not BuildInfo metadata is published using the <publisher> configuration. |
| Controls auto-discovery and violation monitoring of third-party licenses |
| Configures Artifactory BlackDuck integration. Note that you need to specify <runChecks>true</runChecks> to activate it. |
Reading Environment Variables and System Properties
Every build server provides its own set of environment variables. You can utilize these variables when configuring the plugin as shown in the following example:
<publisher>
<contextUrl>{{ARTIFACTORY_CONTEXT_URL|"https://oss.jfrog.org"}}</contextUrl>
...
</publisher>
<buildInfo>
<buildNumber>{{DRONE_BUILD_NUMBER|TRAVIS_BUILD_NUMBER|CI_BUILD_NUMBER|BUILD_NUMBER|"333"}}</buildNumber>
<buildUrl>{{DRONE_BUILD_URL|CI_BUILD_URL|BUILD_URL}}</buildUrl>
</buildInfo>
Any plugin configuration value can contain several {{ .. }} expressions. Each expression can contain a single or multiple environment variables or system properties to be used.
The expression syntax allows you to provide enough variables to accommodate any build server requirements according to the following rules:
- Each expression can contain several variables, separated by a ' | ' character to be used with a configuration value
- The last value in a list is the default that will be used if none of the previous variables is available as an environment variable or a system property
For example, for the expression {{V1|V2|"defaultValue"}} the plugin will attempt to locate environment variable V1, then system property V1, then environment variable or system property V2, and if none of these is available, "defaultValue" will be used.
If the last value is not a string (as denoted by the quotation marks) and the variable cannot be resolved, null will be used (for example, for expression {{V1|V2}} where neither V1 nor V2 can be resolved).
You can attach additional artifacts to your module using the Build Helper Maven Plugin.
Keeping your Artifactory publisher credentials secure
If you prefer to keep your Artifactory publisher credentials (username and password) secure (rather than providing them as free text in the plugin configuration), we recommend storing them as environment variables or system properties and have the plugin read them when needed. Since the usual Maven deploy does not support environment variables or system properties in settings.xml, this capability is unique to the Maven Artifactory Plugin.
Examples
The folllowing project provides a working example of using the plugin: