Install Mend for GitHub.com

Overview

Before scanning your repositories with Mend for GitHub.com, you will need to install the Mend for GitHub.com app from the GitHub Marketplace and connect your Mend organization to it.

This article provides installation instructions for Mend for GitHub.com. This article also provides instructions on how to uninstall the app.

Getting It Done

Prerequisites before you install Mend for GitHub.com

• Access to an active Mend Platform organization and be a user with organization administrator permissions.

• The Issues tab must be enabled for each repository. Do as follows for each repository requiring a scan:

  1. Go to the relevant GitHub repository, and click Settings.

  2. Verify that the Issues checkbox is enabled. 

  3. Check that the Issues tab appears next to the Code tab.

• You must have administrator permissions to your GitHub account and to the relevant repositories (owner credentials) to install the Mend for GitHub.com app.

Note: When setting up repository integrations, you can only connect one source code management (SCM) system to a single Mend organization. For example, if you integrate a GitHub organization, you cannot link additional SCM systems like GitLab groups or Bitbucket teams to the same Mend organization.

Connect your Mend organization

After you install the Mend for GitHub.com app, there will be a registration form provided to connect your Mend organization. You will need to obtain your Mend license key:

1. Within the Mend Application, navigate to Settings (cog icon in the top-right corner) → Integrations.

   

2. On the Integrations page, toggle the GitHub.com bar to expand its settings.

3. Click on Generate Activation Key and copy the value.

   

Note: The license key is valid for 24 hours. You must generate a new license key if you have not submitted the registration form below within 24 hours.

Note: After you generate the Mend license key, a service user named ws_4_ghc_service_user is created in your Mend organization in the admins group. Do not remove this service user or its permissions as it is required for the Mend GitHub.com integration to function correctly:

Install the Mend for GitHub.com app

1. Navigate to the Mend for GitHub.com app page in the GitHub Marketplace.

2. Click Install:

   

3. If you have multiple organizations, select the organization you wish to install Mend for GitHub.com:

   

   Otherwise, move to step 4.

4. Read and select the level of access for the Mend for GitHub.com app:

   • All Repositories (Default): An option to scan all the repositories of the account.

   • Only select repositories: Select specific repositories that you would like to scan.

5. Click Install:

   

6. Read over the requested permissions and select Authorize Mend for GitHub.com:

   

7. After you install the Mend for GitHub.com app, there will be a registration form provided to connect your Mend organization. Fill out the provided registration form to connect your Mend organization:
   

   

8. First Name: Your first name

9. Last Name: Your last name

10. Email: Your email address

11. Company: (Optional) Your company name

12. License Key: Your Mend license key

13. Country: Your country

14. Read and check off GitHub’s documents:

    • I agree to the terms of service

    • I agree to the privacy policy

15. Click on Submit

Next Steps after installing Mend for GitHub.com

Congratulations, you’ve successfully installed Mend for GitHub.com! You are ready to get started with the many functionalities that Mend for GitHub.com has to offer.

Uninstall Mend for GitHub.com

To uninstall Mend for GitHub.com from your GitHub organization or personal profile:

Uninstall Mend for GitHub.com from your GitHub organization

1. Within GitHub.com, navigate to Your organizations → select the Settings option of the organization integrated with Mend:

   

2. In the left-hand table of contents, find the Third-party Access section and click on GitHub Apps:

   

3. Find Mend for GitHub.com and click on Configure:

   

4. Scroll down to the Danger zone section and select Uninstall:

   

Uninstall Mend for GitHub.com from your personal profile

1. Within GitHub.com, navigate to your Settings section.

2. In the left-hand table of contents, find the Integrations section and click on Applications:

   

3. In the Installed GitHub Apps tab, find Mend for GitHub.com and click on Configure:

   

   • Optionally, go to the Authorized GitHub Apps tab, find Mend for GitHub.com, and click on Revoke:

     

4. On the configuration page, scroll down to the Danger zone section and select Uninstall: