8000 Hl/multi jira server docs by hussam789 · Pull Request #1845 · qodo-ai/pr-agent · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Hl/multi jira server docs #1845

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Jun 4, 2025
Merged

Hl/multi jira server docs #1845

merged 3 commits into from
Jun 4, 2025

Conversation

hussam789
Copy link
Collaborator
@hussam789 hussam789 commented Jun 3, 2025 •
edited by qodo-merge-for-open-source bot
Loading

PR Type

Documentation

Description

  • Add detailed documentation for multi-JIRA server configuration

  • Provide configuration examples for various authentication methods

  • Clarify default server selection and ticket ID resolution

  • Improve formatting and consistency in Linear integration section

Changes diagram

flowchart LR
  multiJira["Multi-JIRA Server Support"] 
  authMethods["Authentication Methods"]
  configExamples["Configuration Examples"]
  defaultServer["Default Server Selection"]
  linearSection["Linear Integration Formatting"]

  multiJira -- "explains" --> authMethods
  authMethods -- "includes" --> configExamples
  configExamples -- "shows" --> defaultServer
  multiJira -- "clarifies" --> defaultServer
  multiJira -- "improves" --> linearSection
Loading

Changes walkthrough 📝

Relevant files
Documentation
fetching_ticket_context.md
Add multi-JIRA server configuration and clarify integration steps

docs/docs/core-abilities/fetching_ticket_context.md

  • Added section on configuring multiple JIRA servers
  • Provided examples for Email/Token, PAT, and Cloud App authentication
  • Clarified default server and ticket ID resolution logic
  • Improved formatting for Linear integration instructions
    		• +83/-7   
    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
    •

    @qodo-merge-for-open-source Qodo Merge for Open Source
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 Security concerns

    Sensitive information exposure:
    The documentation examples include placeholder API tokens and credentials (lines 310-313, 335-336, 345-347). While these are clearly placeholders, it would be beneficial to add explicit notes that these are example values and should be replaced with actual credentials. This helps prevent users from accidentally committing configuration files with the example values intact.

    ⚡ Recommended focus areas for review

    Security Exposure

    The documentation examples include placeholder API tokens and credentials that might be misinterpreted as real values. Consider adding explicit warnings that these are placeholders.

     
    jira_api_token = ["cloud_api_token_here", "datacenter_password"]

# Emails/usernames (both required)
jira_api_email = ["user@company.com", "datacenter_username"]
    Inconsistent Formatting

    The documentation uses different styles for describing configuration options - sometimes using bullet points and sometimes using prose. Consider standardizing the format across all authentication method sections.

     
    Qodo Merge supports connecting to multiple JIRA servers using different authentication methods.

=== "Email/Token (Basic Auth)"

    Configure multiple servers using Email/Token authentication:

    - `jira_servers`: List of JIRA server URLs
    - `jira_api_token`: List of API tokens (for Cloud) or passwords (for Data Center)
    - `jira_api_email`: List of emails (for Cloud) or usernames (for Data Center)
    - `jira_base_url`: Default server for ticket IDs like `PROJ-123`, Each repository can configure (local config file) its own `jira_base_url` to choose which server to use by default.

    **Example Configuration:**
    ```toml
    [jira]
    # Server URLs
    jira_servers = ["https://company.atlassian.net", "https://datacenter.jira.com"]

    # API tokens/passwords
    jira_api_token = ["cloud_api_token_here", "datacenter_password"]

    # Emails/usernames (both required)
    jira_api_email = ["user@company.com", "datacenter_username"]

    # Default server for ticket IDs
    jira_base_url = "https://company.atlassian.net"
    ```

=== "PAT Auth"

    Configure multiple servers using Personal Access Token authentication:

    - `jira_servers`: List of JIRA server URLs
    - `jira_api_token`: List of PAT tokens
    - `jira_api_email`: Not needed (can be omitted or left empty)
    - `jira_base_url`: Default server for ticket IDs like `PROJ-123`, Each repository can configure (local config file) its own `jira_base_url` to choose which server to use by default.

    **Example Configuration:**
    ```toml
    [jira]
    # Server URLs
    jira_servers = ["https://server1.jira.com", "https://server2.jira.com"]

    # P
8000
AT tokens only
    jira_api_token = ["pat_token_1", "pat_token_2"]

    # Default server for ticket IDs
    jira_base_url = "https://server1.jira.com"
    ```

    **Mixed Authentication (Email/Token + PAT):**
    ```toml
    [jira]
    jira_servers = ["https://company.atlassian.net", "https://server.jira.com"]
    jira_api_token = ["cloud_api_token", "server_pat_token"]
    jira_api_email = ["user@company.com", ""]  # Empty for PAT
    ```

=== "Jira Cloud App"

    For Jira Cloud instances using App Authentication:

    1. Install the Qodo Merge app on each JIRA Cloud instance you want to connect to
    2. Set the default server for ticket ID resolution:

    ```toml
    [jira]
    jira_base_url = "https://primary-team.atlassian.net"
    ```

    Full URLs (e.g., `https://other-team.atlassian.net/browse/TASK-456`) will automatically use the correct connected instance.

    @hussam789 hussam789 requested a review from mrT23 June 3, 2025 12:12
    @qodo-merge-for-open-source Qodo Merge for Open Source
    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    Learned
    best practice
    Maintain consistent product branding

    The product name should be consistently styled as "Qodo AI" or "Qodo AI Merge"
    in user-facing documentation to maintain brand consistency. Update the product
    name reference to match the official branding.

    docs/docs/core-abilities/fetching_ticket_context.md [292]

    -Qodo Merge supports connecting to multiple JIRA servers using different authentication methods.
+Qodo AI Merge supports connecting to multiple JIRA servers using different authentication methods.
    • Apply / Chat
    Suggestion importance[1-10]: 6

    __

    Why:
    Relevant best practice - Fix grammatical errors and typos in user-facing documentation to maintain professionalism and clarity.

    		Low
    General
    Clarify mixed authentication example

    Add a brief explanation about the mixed authentication example to clarify which
    server uses which authentication method. This will help users understand the
    configuration pattern better.

    docs/docs/core-abilities/fetching_ticket_context.md [341-347]

     **Mixed Authentication (Email/Token + PAT):**
 ```toml
 [jira]
+# First server uses Email/Token, second uses PAT
 jira_servers = ["https://company.atlassian.net", "https://server.jira.com"]
 jira_api_token = ["cloud_api_token", "server_pat_token"]
 jira_api_email = ["user@company.com", ""]  # Empty for PAT
    
- [ ] **Apply / Chat** <!-- /improve --apply_suggestion=1 -->

<details><summary>Suggestion importance[1-10]: 5</summary>

__

Why: Adding a clarifying comment about which server uses which authentication method improves documentation readability, though it's a minor enhancement rather than addressing a critical issue.


</details></details></td><td align=center>Low

</td></tr>
<tr><td align="center" colspan="2">

- [ ] More <!-- /improve --more_suggestions=true -->

</td><td></td></tr></tbody></table>

- [ ]  **Author self-review**: I have reviewed the PR code suggestions, and addressed the relevant ones. <!-- fold suggestions self-review -->

    @hussam789
    Copy link
    Collaborator Author

    /review auto_approve

    @qodo-merge-for-open-source Qodo Merge for Open Source
    Copy link
    Contributor

    Manual-approval option for PR-Agent is disabled. You can enable it via a configuration file

    @hussam789 hussam789 merged commit a250063 into main Jun 4, 2025
    2 checks passed
    @hussam789 hussam789 deleted the hl/multi_jira_server_docs branch June 4, 2025 18:34
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @ofir-frd ofir-frd ofir-frd approved these changes

    @mrT23 mrT23 Awaiting requested review from mrT23

    Assignees
    No one assigned
    Labels
    Review effort 2/5
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    2 participants
    @hussam789 @ofir-frd
    0