Getting started with Codacy

When you start setting up a project you have to 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

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

 

1. Requirements


Git Server: We support any Git server, including GitHub, Bitbucket, GitLab, or any other git hosting provider. Other version control systems are not supported.

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 that 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 with your GitHub account, when you click on the Add project button, a list of GitHub projects will be listed. Otherwise you may need to select the Import from GitHub on the left side.

If your repository is private on GitHub, you may need to select Include private repositories (on the left) to grant additional permissions to Codacy, so that we can display private repositories as well.

Select the organisation and team for which you want to add the project on Codacy.

After finding your repository, just click on the checkbox and the project will be added.

Your repository has now been imported and a first analysis will be made.

If you wish to analyse other repositories as well there’s no need to repeat the wizard, just select the other repositories.

When you are done with adding the desired projects, just 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, then select Import from Bitbucket.

You will need to provide access to Codacy to access your repositories:


Access to your account

After finding your repository, select it and click Add.

Your repository has now been imported and a first analysis will be made.

 

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 that this 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.

Then all you need to do is to 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.

Have more questions? Submit a request

0 Comments

Article is closed for comments.