# GitHub Issues

GitHub is a widely used platform for version control and collaborative software development. It enables teams to manage repositories, track issues, and collaborate efficiently through pull requests, code reviews, and project boards.

Integrating OX Security with GitHub enhances your software development lifecycle by embedding security insights directly into your GitHub workflow, as follows:

* **Automated Issue Tracking**: Security findings detected by OX Security can be logged as issues or pull requests in GitHub, ensuring that vulnerabilities are tracked and addressed promptly.
* **Seamless Collaboration**: Developers, security teams, and project managers can manage security-related tasks within their existing GitHub environment, streamlining the remediation process and improving team collaboration.
* **Improved Security Visibility**: The integration provides clear visibility into security risks within the development pipeline, helping teams prioritize and resolve issues more efficiently.
* **Enhanced Compliance Management**: Organizations can ensure compliance by tracking security-related tasks alongside other development activities, simplifying audits and reporting.

## Prerequisites

GitHub account.

{% hint style="info" %}
OX integration supports GitHub privet repositories only.
{% endhint %}

## Connecting to GitHub Issues

1. [Get a GitHub token.](https://docs.ox.security/get-started/onboarding-to-ox/source-control/github/getting-github-tokens)
2. In the **OX** platform, go to **Connectors** and search for **GitHub Issues**.

<figure><img src="https://884876233-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdK3XMLdV8zRg847RmGmZ%2Fuploads%2Fgit-blob-21ff6cf6202d81ab6fb4e5a406bf7e3b890de463%2FGH_issues_icon1%20(1).png?alt=media" alt="" width="86"><figcaption></figcaption></figure>

2. Select **GitHub Issues** and set the following parameters in the **Configure your GitHub Issues credentials** dialog.

<figure><img src="https://884876233-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdK3XMLdV8zRg847RmGmZ%2Fuploads%2Fgit-blob-f788a68fefdf502dd13d4989c9dc4b9c185662e4%2FGH_connect%20(1).png?alt=media" alt="" width="375"><figcaption></figcaption></figure>

| Parameter                  | Description                                                                                                     |
| -------------------------- | --------------------------------------------------------------------------------------------------------------- |
| **GitHub Issues Host URL** | Add your GitHub organization account URL.                                                                       |
| **Token**                  | Paste the GitHub token you have created.                                                                        |
| **Token Name**             | <p>The token name is automatically generated by OX.<br>You can change/edit the connection name at any time.</p> |

3. Select **CONNECT**. The success message appears.

## Adding GitHub Tickets

After establishing the connection with Jira, you can add Jira tickets for a variety of tasks and issues in OX using one of the following methods:

* Adding a new ticket to an issue, or bulk of issues.
* Adding a new ticket as a scheduled task using workflows.

<figure><img src="https://884876233-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdK3XMLdV8zRg847RmGmZ%2Fuploads%2Fgit-blob-d1ab936b7c3d0b7f33dd7b1da9d15d21cd27803c%2FGH_WF.png?alt=media" alt="" width="202"><figcaption></figcaption></figure>

**To add a new GitHub ticket in OX:**

1. In the **Issues** page, identify and select the issue for which you want to add a ticket in GitHub.
2. Select the GitHub icon.

<figure><img src="https://884876233-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdK3XMLdV8zRg847RmGmZ%2Fuploads%2Fgit-blob-5d3a1fed19bc8e9c239aa5358567b4287ed57efd%2FGH_issues_icon.png?alt=media" alt=""><figcaption></figcaption></figure>

3. Set the ticket parameters in the **Create GitHub Issue Ticket** dialog.

<figure><img src="https://884876233-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdK3XMLdV8zRg847RmGmZ%2Fuploads%2Fgit-blob-5cfb2e670d377064b86e1435808dd177c8c2e094%2FGH_issue_ticket.png?alt=media" alt="" width="563"><figcaption></figcaption></figure>

| Parameter        | Description                                                                                    |
| ---------------- | ---------------------------------------------------------------------------------------------- |
| **Title**        | The title of the ticket that describes the problem/issue, as it appears in the OX Issues page. |
| **Organization** | Your organization name.                                                                        |
| **Project**      | The name of the project, as it's defined in GitHub.                                            |
| **Labels**       | Select GitHub labels.                                                                          |
| **Repository**   | Select the repository where the issue was identified.                                          |
| **Assigned To**  | Select the person to who you want to assign the ticket.                                        |

4. Select **CREATE TICKET**.

The new ticket appears in GitHub.

<figure><img src="https://884876233-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdK3XMLdV8zRg847RmGmZ%2Fuploads%2Fgit-blob-63cf70a79fb7446913751496fd08916d50c24be6%2FGH_final_ticket.png?alt=media" alt=""><figcaption></figcaption></figure>