From 633a1c7bd02c63c7c7d81acab8a1d3627d650b94 Mon Sep 17 00:00:00 2001 From: "Hussam.lawen" Date: Wed, 15 Jan 2025 17:03:31 +0200 Subject: [PATCH 1/3] documentation --- .../core-abilities/fetching_ticket_context.md | 39 ++++++++++++++++++- 1 file changed, 37 insertions(+), 2 deletions(-) diff --git a/docs/docs/core-abilities/fetching_ticket_context.md b/docs/docs/core-abilities/fetching_ticket_context.md index 22c55f3d..2360109f 100644 --- a/docs/docs/core-abilities/fetching_ticket_context.md +++ b/docs/docs/core-abilities/fetching_ticket_context.md @@ -120,9 +120,44 @@ jira_api_email = "YOUR_EMAIL" ``` -#### Jira Server/Data Center 💎 +#### Jira Data Center/Server 💎 -Currently, we only support the Personal Access Token (PAT) Authentication method. +##### Local App Authentication (For Qodo Merge On-Premise Customers) + +##### 1. Step 1: Set up an application link in Jira Data Center/Server +* Go to Jira Administration > Applications > Application Links > Click on `Create link` +![application links](https://www.qodo.ai/images/pr_agent/jira_app_links.png){width=384} +* Choose `External application` and set the direction to `Incoming` and then click `Continue` + +![external application](https://www.qodo.ai/images/pr_agent/jira_create_link.png){width=256} +* In the following screen, enter the following details: + * Name: `Qodo Merge` + * Redirect URL: Enter you Qodo Merge URL followed `https://{QODO_MERGE_ENDPOINT}/register_ticket_provider` + * Permission: Select `Read` + * Click `Save` + +![external application details](https://www.qodo.ai/images/pr_agent/jira_fill_app_link.png){width=384} +* Copy the `Client ID` and `Client secret` and set them in you `.secrets` file: + +![client id and secret](https://www.qodo.ai/images/pr_agent/jira_app_credentionals.png){width=256} +```toml +[jira] +jira_app_secret = "..." +jira_client_id = "..." +``` + +##### 2. Step 2: Authenticate with Jira Data Center/Server +* Open this URL in your browser: `https://{QODO_MERGE_ENDPOINT}/jira_auth` +* Click on link + +![jira auth success](https://www.qodo.ai/images/pr_agent/jira_auth_page.png){width=384} + +* You will be redirected to Jira Data Center/Server, click `Allow` +* You will be redirected back to Qodo Merge PR Agent and you will see a success message. + + +##### Personal Access Token (PAT) Authentication +We also support Personal Access Token (PAT) Authentication method. 1. Create a [Personal Access Token (PAT)](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html) in your Jira account 2. In your Configuration file/Environment variables/Secrets file, add the following lines: From 1f86cbc94218cd2f7de8f8ebd9acbb820616d382 Mon Sep 17 00:00:00 2001 From: "Hussam.lawen" Date: Wed, 15 Jan 2025 17:23:20 +0200 Subject: [PATCH 2/3] typo --- docs/docs/core-abilities/fetching_ticket_context.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/core-abilities/fetching_ticket_context.md b/docs/docs/core-abilities/fetching_ticket_context.md index 2360109f..32ce6332 100644 --- a/docs/docs/core-abilities/fetching_ticket_context.md +++ b/docs/docs/core-abilities/fetching_ticket_context.md @@ -132,12 +132,12 @@ jira_api_email = "YOUR_EMAIL" ![external application](https://www.qodo.ai/images/pr_agent/jira_create_link.png){width=256} * In the following screen, enter the following details: * Name: `Qodo Merge` - * Redirect URL: Enter you Qodo Merge URL followed `https://{QODO_MERGE_ENDPOINT}/register_ticket_provider` + * Redirect URL: Enter your Qodo Merge URL followed `https://{QODO_MERGE_ENDPOINT}/register_ticket_provider` * Permission: Select `Read` * Click `Save` ![external application details](https://www.qodo.ai/images/pr_agent/jira_fill_app_link.png){width=384} -* Copy the `Client ID` and `Client secret` and set them in you `.secrets` file: +* Copy the `Client ID` and `Client secret` and set them in your `.secrets` file: ![client id and secret](https://www.qodo.ai/images/pr_agent/jira_app_credentionals.png){width=256} ```toml From d0c442b74b7f7b56131657074fd28d03e2d4ec85 Mon Sep 17 00:00:00 2001 From: "Hussam.lawen" Date: Wed, 15 Jan 2025 17:24:37 +0200 Subject: [PATCH 3/3] enter --- docs/docs/core-abilities/fetching_ticket_context.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/docs/core-abilities/fetching_ticket_context.md b/docs/docs/core-abilities/fetching_ticket_context.md index 32ce6332..8b9f8cd1 100644 --- a/docs/docs/core-abilities/fetching_ticket_context.md +++ b/docs/docs/core-abilities/fetching_ticket_context.md @@ -126,6 +126,7 @@ jira_api_email = "YOUR_EMAIL" ##### 1. Step 1: Set up an application link in Jira Data Center/Server * Go to Jira Administration > Applications > Application Links > Click on `Create link` + ![application links](https://www.qodo.ai/images/pr_agent/jira_app_links.png){width=384} * Choose `External application` and set the direction to `Incoming` and then click `Continue`