Getting Started

Using Personal Access Tokens for GitLab Integration

This guide explains how to generate and configure a personal access token (PAT) for securely connecting your GitLab instance with Jira. PATs provide a secure method for authentication, eliminating the need for direct username and password usage while ensuring that access is limited to the necessary API scope.

Step 1: Create a Personal Access Token in GitLab

1. Log in to GitLab Sign in to your GitLab instance with your user credentials.

2. Navigate to the Access Tokens Section

   • Go to your user settings and select Access Tokens.

   • Alternatively, you can use GitLab’s documentation on personal access tokens for detailed instructions.

3. Configure the Token

   • Name: Provide a descriptive name (e.g., “GitConnector Integration”).

   • Scopes: Select the API scope to allow access for GitConnector.

   • Expiration (optional): Set an expiration date to enforce periodic token renewal.

4. Generate and Secure Your Token Click Create personal access token. Important: Copy the generated token immediately. You won’t be able to view it again, so store it securely.

Step 2: Configure Your Jira Instance

1. Access Jira Log in to your Jira instance.

2. Locate the GitLab PAT Configuration Click on the "GitLab PAT" button available in:

   • Issue View

   • Configuration

   • Project Configuration

1. Enter Token Details When the "Add a personal access token" dialog appears:

   • GitLab Instance URL: Enter the base URL of your GitLab instance.

   • Access Token: Paste the personal access token generated in Step 1.

2. Save Your Configuration Click the Save button to apply the changes.

Step 3: Verify and Troubleshoot

• Verification: Once saved, verify the integration by checking the logs or testing the connection in Jira. Successful integration should allow GitLab data to be fetched seamlessly.

• Troubleshooting: If you experience issues:

  • Confirm the token has the correct API scope.

  • Ensure the GitLab URL is accurate.

Security Considerations

• Handle Tokens Securely: Treat your personal access token as a sensitive credential. Please do not share it or expose it in public repositories.

• Regular Token Renewal: Consider setting an expiration date and periodically regenerating your token to minimize security risks.

Additional Resources

• GitLab Documentation: For more details on creating and managing personal access tokens, visit the official GitLab docs.

• Jira Integration Support: If you need further assistance, refer to the Troubleshooting section or contact our support team.

This revised page is designed to enhance user comprehension by providing structured, clear, and actionable steps while emphasizing security and reliability.

Installation

1. Log into your Jira instance as an admin.

2. Click the admin dropdown and choose Add-ons. The Find new apps or Find new add-ons screen loads.

3. Locate GitHub integration for Jira and click on the app tile. The App Details screen loads.

4. Click Install to download and install your app.

5. You're all set! Click Close in the Installed and ready to go dialog.

Configuration

1. Go to the configuration page (Apps -> GitHub integration for Jira).

2. Click on the "GitHub.com OAuth" button.

3. Sign in to GitHub in an opened popup.

4. Authorize access to your repositories and organizations.

5. Select repositories related to your projects.

​Create a new branch