debian-mirror-gitlab/doc/development/integrations/jira_connect.md

44 lines
1.9 KiB
Markdown
Raw Normal View History

2019-07-31 22:56:46 +05:30
# Setting up a development environment
The following are required to install and test the app:
1. A Jira Cloud instance
2019-09-30 21:07:59 +05:30
Atlassian provides free instances for development and testing. [Click here to sign up](https://developer.atlassian.com/platform/marketplace/getting-started/#free-developer-instances-to-build-and-test-your-app).
2019-07-31 22:56:46 +05:30
1. A GitLab instance available over the internet
For the app to work, Jira Cloud should be able to connect to the GitLab instance through the internet.
2019-12-04 20:38:33 +05:30
To easily expose your local development environment, you can use tools like
2020-10-24 23:57:45 +05:30
[serveo](https://medium.com/automationmaster/how-to-forward-my-local-port-to-public-using-serveo-4979f352a3bf)
2019-12-04 20:38:33 +05:30
or [ngrok](https://ngrok.com). These also take care of SSL for you because Jira
requires all connections to the app host to be over SSL.
2019-07-31 22:56:46 +05:30
2019-09-30 21:07:59 +05:30
## Installing the app in Jira
2019-07-31 22:56:46 +05:30
1. Enable Jira development mode to install apps that are not from the Atlassian Marketplace
1. Navigate to **Jira settings** (cog icon) > **Apps** > **Manage apps**.
1. Scroll to the bottom of the **Manage apps** page and click **Settings**.
1. Select **Enable development mode** and click **Apply**.
1. Install the app
1. Navigate to Jira, then choose **Jira settings** (cog icon) > **Apps** > **Manage apps**.
1. Click **Upload app**.
1. In the **From this URL** field, provide a link to the app descriptor. The host and port must point to your GitLab instance.
For example:
2019-09-30 21:07:59 +05:30
2020-04-22 19:07:51 +05:30
```plaintext
2019-07-31 22:56:46 +05:30
https://xxxx.serveo.net/-/jira_connect/app_descriptor.json
```
2019-09-30 21:07:59 +05:30
2019-07-31 22:56:46 +05:30
1. Click **Upload**.
If the install was successful, you should see the **GitLab for Jira** app under **Manage apps**.
You can also click **Getting Started** to open the configuration page rendered from your GitLab instance.
_Note that any changes to the app descriptor requires you to uninstall then reinstall the app._