How to set up an advanced scripting environment for Jira Cloud and Jira on-premise

To configure your synchronization use case, you need to use advanced Groovy scripting. It requires setting up the scripting environment.

This article describes how to set up the development environment and find out what Jira and Exalate APIs you can use.

To set up an Integrated Development Environment(IDE)

1. Install Java JDK
2. Install Atlassian SDK: Windows, Mac or Linux
3. Install an IDE:
   1. we suggest to use IntelliJ IDEA Community Edition - it's free. Use default configuration.
4. Install Git
5. Configure IDE to use Maven from the Atlassian SDK:
   1. Find your Atlassian SDKs Maven Home:
      • On Windows:
        • Open Start - cmd

        • type

          atlas-version

          You get the result as the example below.

          ATLAS Version:    6.2.9
          ATLAS Home:       C:\Applications\Atlassian\atlassian-plugin-sdk-6.2.9
          ATLAS Scripts:    C:\Applications\Atlassian\atlassian-plugin-sdk-6.2.9\bin
          ATLAS Maven Home: C:\Applications\Atlassian\atlassian-plugin-sdk-6.2.9\apache-maven-3.2.1
          AMPS Version:     6.2.6
          --------
          Executing: "C:\Applications\Atlassian\atlassian-plugin-sdk-6.2.9\apache-maven-3.2.1\bin\mvn.bat" --version -gs C:\Applications\Atlassian\atlassian-plugin-sdk-6.2.9\apache-maven-3.2.1/conf/settings.xml
          Apache Maven 3.2.1 (ea8b2b07643dbb1b84b6d16e1f08391b666bc1e9; 2014-02-15T04:37:52+10:00)
          Maven home: C:\Applications\Atlassian\atlassian-plugin-sdk-6.2.9\apache-maven-3.2.1\bin\..
          Java version: 1.8.0_91, vendor: Oracle Corporation
          Java home: C:\Program Files\Java\jdk1.8.0_91\jre
          Default locale: en_AU, platform encoding: Cp1252
          OS name: "windows 10", version: "10.0", arch: "amd64", family: "dos"

          Find the ATLAS Maven Home:

          ATLAS Maven Home: C:\Applications\Atlassian\atlassian-plugin-sdk-6.2.9\apache-maven-3.2.1

      • on Mac or Linux:

        • Run terminal

        • Type

          atlas-version

          You get the following result:

          ATLAS Version:    6.1.0
          ATLAS Home:       /Applications/Atlassian/atlassian-plugin-sdk-6.1.0
          ATLAS Scripts:    /Applications/Atlassian/atlassian-plugin-sdk-6.1.0/bin
          ATLAS Maven Home: /Applications/Atlassian/atlassian-plugin-sdk-6.1.0/apache-maven-3.2.1
          AMPS Version:     6.1.2
          --------
          Executing: /Applications/Atlassian/atlassian-plugin-sdk-6.1.0/apache-maven-3.2.1/bin/mvn --version -gs /Applications/Atlassian/atlassian-plugin-sdk-6.1.0/apache-maven-3.2.1/conf/settings.xml
          Java HotSpot(TM) 64-Bit Server VM warning: ignoring option MaxPermSize=256M; support was removed in 8.0
          Apache Maven 3.2.1 (ea8b2b07643dbb1b84b6d16e1f08391b666bc1e9; 2014-02-14T19:37:52+02:00)
          Maven home: /Applications/Atlassian/atlassian-plugin-sdk-6.1.0/apache-maven-3.2.1
          Java version: 1.8.0_92, vendor: Oracle Corporation
          Java home: /Library/Java/JavaVirtualMachines/jdk1.8.0_92.jdk/Contents/Home/jre
          Default locale: en_US, platform encoding: UTF-8
          OS name: "mac os x", version: "10.13.2", arch: "x86_64", family: "mac"

          Find the ATLAS Maven Home:

          ATLAS Maven Home: /Applications/Atlassian/atlassian-plugin-sdk-6.1.0/apache-maven-3.2.1

   2. Start IntelliJ IDEA
   3. Navigate to Configure (Preferences) - Build, Execution, Deployment - Build Tools - Maven. Change the Maven Home directory setting from Bundled to Maven Home directory from the previous step
6. Copy an example project
   Download the example project:
   JiraServer_scripts.zip
   JiraCloud_scripts.zip
   

   Extract the project from archive to proceed to the next step.

7. Open the example project directory in your IntelliJ IDEA  
8. Mark as source your scripts directory in the project structure:
   File - Project Structure - Modules tab 

   

9. Download Atlassian and Exalate libraries to get the autocomplete when editing scripts.
   Run the following command in your IntelliJ IDEA terminal.

   atlas-mvn clean compile

10. Reimport all maven projects to finish the configuration.

Congratulations! Example advanced scripting environment is ready.

Now you can navigate to any of these scripts from your development environment. IntelliJ provides autocomplete for the available variables and the Jira. API(com.atlassian.jira.component.ComponentAccessor).

mvn install:install-file \
   -Dfile=<path-to-file> \
   -DgroupId=<group-id> \
   -DartifactId=<artifact-id> \
   -Dversion=<version> \
   -Dpackaging=<packaging> \
   -DgeneratePom=true