UPM Maven Plugin

Provides Maven goals to interact with Atlassian UPM REST API.

License

License

Categories

Categories

Maven Build Tools Net
GroupId

GroupId

com.linked-planet.maven
ArtifactId

ArtifactId

upm-maven-plugin
Last Version

Last Version

2.0.1
Release Date

Release Date

Type

Type

maven-plugin
Description

Description

UPM Maven Plugin
Provides Maven goals to interact with Atlassian UPM REST API.
Project URL

Project URL

https://github.com/linked-planet/upm-maven-plugin
Source Code Management

Source Code Management

https://github.com/linked-planet/upm-maven-plugin

Download upm-maven-plugin

How to add to project

<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

Build Status License

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
com.linked-planet.maven

linked-planet GmbH

software for people, people for software

Versions

Version
2.0.1