> For the complete documentation index, see [llms.txt](https://docs.getint.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.getint.io/guides/integration-synchronization/jira-github-integration.md).
# Jira GitHub integration
Integrating Jira with GitHub using Getint connects your project tracking and code management through two-way synchronization. Whether you’re logging issues in Jira or handling code in GitHub, this setup keeps both teams aligned and informed.
This step-by-step guide shows you how to configure the integration using Personal Access Tokens for authentication.
***
### GitHub-Jira Licensing Model
The GitHub-Jira licensing model with Getint is designed to accommodate different integration needs. Here’s an overview:
#### Standard Licensing
* A Getint license is only required on Jira, allowing seamless data synchronization between GitHub and Jira.
This makes setup simpler and faster, without the need for additional configurations in GitHub.
#### Flexible License
* For managed services companies or organizations looking to integrate four or more instances (regardless of whether they are the same or different tools), Getint offers a **Flexible License.** This custom license covers a specific number of connections (i.e., up to 10 instances) without restrictions on the tools involved. You can also swap the integrated tools while the license remains active, offering unparalleled flexibility.
For more details on licensing, visit our [**Pricing Page**](https://docs.getint.io/billing-and-services/licensing).
#### Requirements to Build Your Integration:
* The **Getint app** must be installed in Jira.
* Comments are attributed to the user who created the connection. Therefore, we recommend using dedicated Service Accounts for both instances.
* Jira instances must have a dedicated user and an associated API token with permissions to read, write, view, and modify the project.
* **Personal Access Tokens** are required for Jira and GitHub authentication. You can find the steps to generate the access token for your connectors here: [Connection Guide](https://docs.getint.io/guides/quickstart/connection#github).
### Setting Up Your GitHub-Jira Integration
#### 1. Access the Getint App in Jira
* Navigate to **Apps** and select **Jira - GitHub Integration**.
#### 2. Create Integration
* Click **Create integration** or **Migration**.
#### 3. Token Generation (Password for Jira Cloud)
* For Jira Cloud, generate a Jira token. This token will act as your password:
* Go to **Atlassian Account Settings**.
* Navigate to **Security** and go to **Generate and manage** **API tokens**, then select an API token or an API token with scopes.
* After creation, use this token as the password for Jira integration. More information about access tokens for Jira [here](https://docs.getint.io/guides/quickstart/connection#jira).
#### **4. Generate a GitHub Personal Access Token**
GitHub supports two token types. You can use a Classic token or a Fine-grained token, depending on your needs.
**Generating a GitHub Token (Classic):**
* Log in to your GitHub account.
* Go to **Settings**, then **Developer settings**.
* Select **Personal access tokens** and click **Generate new token**. In the dropdown menu, select **Generate new token (Classic)**.
* Provide a name for your token, select the scopes like the example in the [Connection Guide](https://docs.getint.io/guides/quickstart/connection#github), and save.
* Copy the token and store it securely, as it will only be visible once.
{% embed url="" %}
**Generating a Fine-Grained Token:**
* Log in to your GitHub account.
* Go to **Settings**, then **Developer settings**.
* Select **Personal access tokens**, then go to **Fine-grained personal access tokens**.
* Click **Generate new token**. Choose a name for your token, set the expiration date and repository access, and provide the necessary access permissions in the dropdown list.
* Copy the token and store it securely, as it will only be visible once.
{% embed url="" %}
#### 5. Connect to Jira
* In Getint, enter your Jira instance URL, username, and the API token.
* Use the **Personal Access Token** for Jira Cloud.
* Select the Jira project you wish to integrate with GitHub.
#### 6. Enter GitHub Token in Getint
* Once you have generated a Personal Access Token in your GitHub instance, you will now have the option to connect the tool to Getint.
* Paste the GitHub Personal Access Token into the API token field.
* Select the GitHub repository or the Project you want to sync with Jira.
* Click Save to establish the connection.
#### 7. Issue Type Mapping
* Map the Jira issue types you want to sync with GitHub tasks, such as mapping a GitHub Task to a Jira task or a Jira bug to a GitHub task.
* Consider using the **Quick Build** beta feature for automated type and field mapping, which can streamline the setup process.
#### 8. Field Mapping
* Review or manually map fields within mapped types, including title, description, and assignees.
* Add your desired fields, and define the sync direction (unidirectional or bi-directional) with the arrows.
#### 9. Assignee Mapping
* Use the assignee mapping option to match Jira assignees to GitHub collaborators, enabling precise synchronization of task ownership. For more details, visit our doc: [Assignees (users) mapping](https://docs.getint.io/getintio-platform/workflows/assignees-users-mapping).
{% hint style="warning" %}
When syncing **projects**, make sure your repository is linked to the target project. If it isn’t, assignees won’t appear in the mapping dropdown.
{% endhint %}
#### 10. Status Mapping
* Map status fields to align between Jira and GitHub. For example, **To do** in Jira could be mapped to **Open** in GitHub.
#### 11. Comments & Attachments
* When enabling comment synchronization, you can filter by criteria such as created date, author, or visibility (public/private).
{% hint style="warning" %}
**Attachment Limitation**: Attachments are currently limited to one-way syncing and are only supported from Jira to GitHub. Attachments in GitHub will not sync to Jira
{% endhint %}
#### 12. Advanced Tab
The **Advanced** tab controls whether Getint creates items, updates items, or both, on each side of the integration. Use it when one side should send work out but not receive new items back.
* Click a type mapping, then open the **Advanced** tab.
* Enable **Customize create/update actions**.
* Select the actions for each side. Clearing **Create Task(s)** on one side stops new items from being created there, while leaving **Update Task(s)** selected still lets updates arrive.
* Click **Apply** and save the integration.
For example, clearing **Create Task(s)** on the Jira side produces this behavior:
* New Jira issues are created in GitHub.
* Updated Jira issues are synced to GitHub.
* New GitHub issues do **not** create issues in Jira.
* Updated GitHub issues that originated from Jira are synced back to Jira.
{% hint style="info" %}
To stop a single type mapping from syncing without deleting it, open its **Advanced** tab, enable customization, and clear every create and update action. Then save the integration.
{% endhint %}
#### 13. Filtering:
* It is possible to filter the synchronization to customize it for your needs and requirements. Please see the doc [Items Filtering](https://docs.getint.io/getintio-platform/workflows/items-filtering) for more details.
**UI Filtering Option:**
* Click on the filtering icon near the app icon in your integration. This will apply to that side of the integration.
* Select whether the filtering applies to All, New, and Synced items.
* Note that if the option **New items** is selected, the filtering will apply only to the new items, and the already synced items will continue to sync and update. If the option **Synced items** is selected, only the already synced items will be updated based on that filter.
* Choose the options and add the value for the filter. It is possible to filter more than one option for each field.
* Select **Apply** after creating the filters and **Save** the integration.
#### 14. Test the Integration
* Create test issues or tasks in Jira or GitHub and observe how they synchronize.
* Ensure that the data between the two platforms is correctly synced.
* Monitor the integration status and the logs in Getint to verify that everything functions as expected.
### Conclusion
By following this guide, you can successfully integrate **Jira** and **GitHub** using Getint. This setup enables smooth synchronization of issues, tasks, and workflows between development and project management tools, helping teams collaborate more effectively and bridging the gap between developers and project managers.
For further assistance, please contact us at the [Support Center](https://getint.io/help-center) or [Schedule a Demo](https://calendly.com/d/cpws-jb2-8xx/demo-call-all-team).
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.getint.io/guides/integration-synchronization/jira-github-integration.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
