Add a project to CodeScan from GitHub
  • 03 Nov 2022
  • 1 Minute to read
  • Contributors
  • Dark
  • PDF

Add a project to CodeScan from GitHub

  • Dark
  • PDF

Article Summary

This document guides how to add a GitHub project to your CodeScan cloud account and run the analysis.

  1. Login to your CodeScan account.
  2. On the top right corner, click on the '+' icon and select Analyze new project.
    Analyze New Project
  3. It takes you to a different window. Choose the Organization for which you'd like to create a project. Click Set Up.Analyze Projects
  4. On the next window, click on Add Analysis Project.Add Analysis Project
  5. You will now see a new pop-up window; select GitHub from the given option.Add New Project
  6. Once you select GitHub, it will redirect to the GitHub login page. Validate your credentials and click on Login.GitHub Login
  7. On the next screen, fill in the details below:
    1. Choose the Repository you want to add, followed by the Project Branch name.
    2. Make sure you select the checkbox under Check Pull Requests
    3. The Project Key and the Project Name are auto-assigned. You can edit the fields as per your requirement.
    4. Click on Add and Run Now.
      About Project Key
      To know where to find the project key, refer to our documentation by clicking HERE.
  8. This triggers the project analysis and the project being added under your CodeScan organization.
  9.  You can view the project analysis report by clicking on Details from your VC repository.VC repository
  10.  When you click the link, it will take you to the CodeScan Project page, where you can view your project's log report.CodeScan Project page

Now that the webhooks have been created, every time there is a push to the tracked branch or a pull request made/updated against the tracked branch, an analysis will be triggered in CodeScan.

Was this article helpful?