UPM Maven Plugin

Provides Maven goals to interact with Atlassian UPM REST API.

License	The Apache License, Version 2.0
Categories	Maven Build Tools Net
GroupId	com.linked-planet.maven
ArtifactId	upm-maven-plugin
Last Version	2.0.1
Release Date	Feb 5, 2021
Type	maven-plugin
Description	UPM Maven Plugin Provides Maven goals to interact with Atlassian UPM REST API.
Project URL	https://github.com/linked-planet/upm-maven-plugin
Source Code Management	https://github.com/linked-planet/upm-maven-plugin

Download upm-maven-plugin

Filename	Size
upm-maven-plugin-2.0.1.pom
upm-maven-plugin-2.0.1.jar	20 KB
upm-maven-plugin-2.0.1-sources.jar	12 KB
upm-maven-plugin-2.0.1-javadoc.jar	32 KB

How to add to project

Apache Maven

<plugin>
    <groupId>com.linked-planet.maven</groupId>
    <artifactId>upm-maven-plugin</artifactId>
    <version>2.0.1</version>
</plugin>

Dependencies

compile (3)

Group / Artifact	Type	Version
org.apache.httpcomponents : httpclient	jar	4.5.13
org.apache.httpcomponents : httpmime	jar	4.5.13
com.google.code.gson : gson	jar	2.8.6

provided (4)

Group / Artifact	Type	Version
org.apache.maven : maven-plugin-api	jar	3.6.3
org.apache.maven : maven-core	jar	3.6.3
org.apache.maven : maven-artifact	jar	3.6.3
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.6.0

Project Modules

There are no modules declared in this project.

UPM Maven Plugin

Provides Maven goals to interact with Atlassian UPM REST API.

Configuration

<plugin>
    <groupId>com.linked-planet.maven</groupId>
    <artifactId>upm-maven-plugin</artifactId>
    <version>2.0.0-SNAPSHOT</version>
    <configuration>
        <!-- mandatory parameters -->
        <baseUrl>https://jira.example.com</baseUrl>
        <username>admin</username>
        <password>admin</password>
        <!-- optional parameters -->
        <timeoutMillis>10000</timeoutMillis>
    </configuration>
</plugin>

Upload plugin JAR file

mvn upm:uploadPluginFile -DpluginKey="my-plugin" -DpluginFile="my-plugin-1.0.0.jar"

Plugin file path is either absolute or relative to pom.xml directory.

Optional parameters

Parameter	Default value	Purpose
waitForSuccessMillis	60000	How long to wait for installation success after file upload

Note that we cannot detect whether the plugin failed to install for certain. We can detect that it did not enable within the given waitForSuccessMillis.

Trigger re-index

Atlassian Jira will complain if not re-indexed after changes to plugins. The plugin therefore provides a command that can be used to re-index Jira after plugin installation. Note however that in most cases, this is not necessary and probably even a bad idea for busy sites.

Caveat: Reindex is pointless if triggered before plugin installation finishes. To avoid this, use waitForSuccessMillis when uploading the plugin file.

mvn upm:reindex

Optional parameters

Parameter	Default value	Purpose
waitForSuccessMillis	60000	How long to wait for reindex to finish; Build will still succeed if exceeded

linked-planet GmbH

software for people, people for software

Versions

Version
2.0.1 Feb 5, 2021