Integraing PoP with JIRA
This post describes how to integrate PoP with JIRA so that you may import Epics into PoP. High level, there are three steps, each of which is described in detail further below:
-
Setting up a JIRA Application Link that describes how PoP will access JIRA
-
Configuring your instance of PoP to access JIRA via the Application Link
-
Testing that your configuration is properly set up
Setting up the Application Link for PoP in JIRA
-
Using your JIRA Administration account, navigate to Applications
- On the Applications administration page, in the left nav, click on Application Links
-
Enter the URL of your PoP development instance (ex. http://localhost:3000) and click Create New Link.
-
Enter details in the Link Applications dialog, being sure to specify Application Name, Generic Application as the Application Type and leaving the Create Incoming link checkbox unchecked. You can leave other settings blank at this step.
-
Click Continue. Your Application Link should now be listed in the Application Links list.
-
In the list of links, click Edit for your Application which will show the Configuration dialog for your AppLink:
-
Click the Incoming Authentication link:
-
Within the Incoming Authentication configuration section, enter a Consumer Key, Consumer Name, and Public Key.
- More information about how to create a Private/Public key pair for your JIRA application is available from Atlassian here.
- Click the Save button at the bottom of the configuration section, and then Close.
Configuring PoP with your new AppLink settings
-
In a text editor, open this file: /app/config/application.yml
-
Set the JIRA_URL value to the root domain URL of your JIRA instance
-
Set the JIRA_CONSUMER_KEY value the Consumer Key you specified for the Application LInk in JIRA
-
Set the JIRA_PRIVATE_KEY_FILE value to the relative path for the private key file that corresponds to the public key you specified in the JIRA Application Link definition
-
Set the JIRA_OAUTH_TOKEN value to a random 32 character value to be used as your app’s default OAuth token
-
Set the JIRA_OAUTH_KEY value to a random 32 character value to be used as your app’s default OAuth key
-
Save the file
Testing Your PoP JIRA Configuration
-
Restart your development instance of PoP
-
In JIRA, create or locate an Epic to be imported into PoP and identify the key for the Epic that you will import. Epics in JIRA take the form PROJ_ID-EPIC_ID.
-
Go to Epics > Import JIRA Epics
-
Leave the Import Type field set to Epic
-
In the Jira ID field, specify the Epic key
-
Click Import
-
You should be prompted to Allow PoP to access JIRA using your JIRA user account via a dialog that looks like this:
-
After allowing the app, got to Epics > This Week
-
You should now see the Epic you imported listed in the set of Epics imported into PoP for the week, which confirms that your instance of PoP is properly connected to JIRA!