Installing and Using the Codespy Github App



The Codespy Github Appcommon file formats (Java, JavaScript, Python, PHP, C++, and C#) for AI generated sections to help QA teams validate code. You can install it by following the procedures below:

screenshot

Installing

Install the Codespy Github App from the Github App marketplace. After you install the app, it will take you to the setup page on Codespy.ai. You will need to either register (for free) to use Codespy, or login if you already have a Codespy account.

Register or login to connect Github to Codespy

Once you register or log in, you will get a message like this:

Github to Codespy connection success

Using

Once you have installed the Codespy Github App and connected it to your Codespy account, Codespy will automatically scan whenever you push to a repository or initiate a pull request.

When scanning is complete, you will see a mark on your repository page if the scan finds some AI. See the red box below:

Github repo page

You can click on the result to see which checks have failed:

Github repo page

After you click details, you will see all of the methods or functions that Codespy found which may contain AI.

Github repo page

Notes

There are a few important notes to be aware of:

  1. Github allows only 50 annotations per push, so if there are more than 50 AI methods/functions in the push, Codespy will stop scanning.
  2. Files must be in a supported language (currently Java, JavaScript, C++, C#, Python, or PHP). There are minimum and maximum file lengths as well. If a file does not meet these specifications it will be ignored.