Getting started with Codacy

When you set up a project, select your source code repository first. At the moment we support GitHub, Bitbucket, and GitLab. If your code is hosted with another Git based provider, you can still use Codacy by importing your project using the manual settings.

Open source projects are free and set as public on Codacy by default.

1. Requirements

  • Git Server: We support any Git server, including GitHub, Bitbucket, GitLab, or any other git hosting provider. Codacy does not support other version control systems.
  • Repository Access: The server hosting your repository has to be accessible by Codacy servers. This is already the case for GitHub or Bitbucket repositories (private or public). Other providers need to make sure access is possible through any firewall.
  • Programming Language Requirements: Codacy supports Scala, Java, JavaScript, PHP, Ruby, Python, and many others, check the full list at Supported Languages.

2. Setting up a GitHub repository

Assuming you are logged in with your GitHub account, when you click on the Add project button, you are presented with a list of GitHub projects. If not, click Import from GitHub on the left side.
 
If your repository is private on GitHub, you might have to select Include private repositories (on the left) to grant additional permissions to Codacy,  to display private repositories. Select the organization and team you want to add the project on Codacy in.
 
After finding your repository, click the check box, and the project is added. Your repository is now imported, and a first analysis will begin. If you wish to analyze other repositories too, there’s no need to repeat the wizard, select the other repositories. When you have added your projects, click on the bottom message to move to the next steps for adding some useful integrations.

After finding your repository, select it and click Add. 

3. Setting up a Bitbucket repository

If your repository is hosted on Bitbucket, select Import from Bitbucket.
You have to provide access to Codacy to access your repositories as following:

Access to your account
After finding your repository, select it and click Add.
Your repository has now been imported, and a first analysis will start.

 

4. Setting up a Git repository manually

If your repository is hosted on a provider other than GitHub or Bitbucket, select Import with Git URL. You’ll then be prompted to choose whether your project is publicly visible or private.
 

PUBLIC

If your repository is public, all you need to do is to provide the public URL of your repository and click Add Project.
Note: if you are having troubles adding a GitLab public project, check the permissions and make sure it is not restricted to "Only team Members."

 

PRIVATE

To a private repository, start by copying the Public Key generated by Codacy and add it to your Git repository.
All you have to do is provide the Git URL of your repository and click Add Project.

Examples of SSH URLs

git@bitbucket.org:codacy/master.git
git@github.com:rtfpessoa/diff2html.git

And that’s it. After the first analysis, you can customize the code patterns of your repositories, in the Code Patterns tab.
If you are having trouble adding an AWS Code commit project, please read this article for detailed information on how to set up the SSH key. 
Have more questions? Submit a request

0 Comments

Article is closed for comments.