• Products
  • Documentation
  • Resources

Integrate GitHub for Security

Connect Jira Software to GitHub so your team can view security containers and vulnerabilities in Jira. Your team can then triage those vulnerabilities, and quickly create new issues to link to them, or link existing issues.

The installation and setup instructions are for GitHub Cloud and GitHub Enterprise Cloud. Read instructions for GitHub Enterprise Server

To install and set up the GitHub for Jira app, you need:

  • Jira site administrator permissions

  • GitHub organization owner permissions

Install the GitHub for Jira app

Install the GitHub for Jira app from the Atlassian Marketplace to connect GitHub to your Jira Software site.

  1. From the top navigation, go to Apps > Explore more apps.

  2. Search for GitHub for Jira, then select it from the list.

  3. Select Get app, then Get it now.

Set up GitHub for Jira

  1. If you have just installed the app, select Get started. Otherwise, from the top navigation, go to Apps > Manage your apps > GitHub for Jira > Get started.

  2. Select Continue.

  3. Select GitHub Cloud, then Next.

  4. Enter your GitHub username and password, then select Sign in.

  5. Select the organization you want to connect to Jira, then select Install or Connect.

GitHub organization owners can find installed apps in GitHub settings. From there, organization owners can review and accept permission requests. Learn about permissions required for GitHub for Jira

Add GitHub Security to a project

To track GitHub vulnerabilities in Jira, you need to add GitHub Security to each project you want them to appear. When you’re back in Jira:

You need project administrator permissions to add GitHub Security to a project.

  1. From your project's sidebar, go to Project settings > Toolchain.

  2. Select the Add button, then Add tool.

  3. Find GitHub Security, then select Add to project.

Connect security containers to your project

The final stage is to connect security containers to your project.

You need project administrator permissions to connect security containers.

  1. From your project's sidebar, go to Project settings > Toolchain.

  2. Select GitHub Security in the list of tools.

  3. Select the add connection button () for GitHub Security.

  4. Choose one or more containers from the list and select Add security container.

Your team can now use the security feature to view recent vulnerabilities found in the linked security containers, and start linking them to issues.

Additional Help