GitHub

Convert Vulnerabilities into GitHub Issues to streamline project management.

Note: This integration is available with the Standard Plus package or above.

What's a GitHub App and why do I need to install it? Read more in the GitHub Docs.

Prerequisites

1. A Portal account with Org Admin permissions.

2. A GitHub account that has Admin permissions on the repository you would like to integrate with. If it's an Organization repository, you need an account with Organization Admin permissions.

Steps

1. Integrate GitHub and Portal.

   1. In the Portal navigation sidebar, locate the Integrations page near the bottom and open it

   2. Find the GitHub integration card, and then click Add GitHub Account.

2. Install the Software Secured GitHub App.

   1. The first step of the integration setup wizard will present a button to install the Software Secured GitHub App. This gives us access to create issues on your repository. Click the button to start the process.

   2. The button will redirect you to login to GitHub (if you're not logged in already), log into your account

   3. When selecting where to install the App, select the owner of the repository you want to integrate with. It could be your own account, or a GitHub Organization if it's an organization repository.

   4. Next, you'll select which repositories the app will have access to. We suggest limiting access to only the repository you will be integrating with Portal.

   5. Click the "Install" button to finish the process, and you will be redirected back to the integration setup in Portal.

3. Select your project and repository.

   1. On Portal, continue enabling the integration.

   2. Select the Portal project and GitHub Repository you would like to connect. When creating GitHub issues from Portal, they will be created in this repository.

   

   Select your GitHub Repository and Portal Project.
4. Configure Issue Fields

   1. Configure the vulnerability information you would like in your GitHub issues. All information will be placed in the issue description formatted as Markdown. Portal labels can be placed in the descripiton, or added as GitHub labels.

   

   Choose the vulnerability information to include in GitHub issues.
5. Review and enable the integration.

   1. Review your integration configuration.

   2. To enable the integration, click Finish.

Results

Use GitHub to track remediation progress for your vulnerabilities. For more information, see Using integrations to track remediation.