Version Control
      Back to home
      1. Help Center
      2. Integrations
      3. Version Control

      Github - User Guide

      In this article, you will understand step by step how to easily integrate with Github

       

       

      Permissions

      The connection should be established by the owner of the organization. Only read access is required for all the listed scopes:

      1. Administration
      2. Checks
      3. Issues
      4. Members
      5. Metadata
      6. Organization administration
      7. Pull requests

      Prerequisites

      1. Organization Owner in Github - Sign in to your Github account as the owner of the organization you wish to connect with.
        1. To confirm that you are the Organization Owner, visit the following page: https://github.com/settings/organizations.
          Make sure you see at least one organization listed on the page.
      2. If you've previously connected Scytale to GitHub organization, you may need to remove the Scytale app before connecting.

      Connecting Scytale & Github


      1. In Scytale menu, navigate to the "integrations" page
      2. Click on Connect GitHub
      3. Add a name for the connection
      4. Click Next



      5. Click on Connect

        6. Upon clicking connect, a new tab will open, guiding you to sign in to GitHub. The connection process in Scytale will remain open, as you come back to complete the connection

        7. You will see a list of your organizations. Choose the GitHub organization you wish to have monitored by Scytale, aligning with the audit scope 

        Note: If "Configure" is visible next to the organization's name, it indicates that the organization already has the Scytale GitHub App installed.
        Please uninstall the app before attempting to connect.



        8. On the next page, you will see the list of permissions which are requested
        9. Repositories selection:

        1. All repositories: Choose this if you want Scytale to monitor all of your repositories within a selected organization, including those created in the future.
        2. Only select repositories: Choose this if you want Scytale to monitor specific repositories only. Unselected repositories will not be monitored (this only applies to private repositories; public ones remain visible even if they're not selected). New repositories created in the future will not be included in the monitoring. To include or remove a new repository from the monitoring you can follow these steps.


        10. Click Install & Authorize
        11. After clicking Install & Authorize, you will be redirected back to Scytale and you've successful connected GitHub ✅

        FAQs

        Which Github pull requests do we collect for auditing?

        Pull requests that have been merged will be monitored, while those in any other status will not be monitored.

        How to change the list of selected repositories after connecting?

        1. Go to the GitHub home page and click on your profile image.

          Screenshot 2024-03-18 at 11.04.17
        2. Select "Your organizations".

          Untitled
        3. Find your organization and click "Settings".

          Untitled2
        4. Go to "GitHub Apps" in the "Third-party Access" section.

          Untitled (1)
        5. Click "Configure" for the "Scytale.ai" connection.

          Untitled (2)
        6. In the "Repository access" tab select new repositories from the list or remove old ones.

          Untitled (3)
        7. Click "Save"

        Troubleshooting


        1. If the user who is trying to connect is not an owner of the selected organization, you may encounter this error.

          How to resolve this issue?

          To confirm that you are the Organization Owner, visit the following page: https://github.com/settings/organizations.

          Make sure you see at least one organization listed on the page.