This document provides a description about how to create a project in SonarQube.
Prerequisites
To be able to enter a project into SonarQube you need a dedicated SonarQube account. Since access to SonarQube is handled via Federated Identity you should be able to log in using your regular GÉANT user account. If that doesn't work please contact us following this process to have an account created for you. If you need further help you may also reach out to the team via the Slack channel dedicated to SonarQube.
Entering the project into SonarQube
To be able to analyse software in SonarQube you need to create a specific SonarQube project first. This can easily be done by following the procedure below.
...
- If you want to be sure only a limited list of Groups and Users can see the project, you need to mark it Private. Once a project is private you will be able to define which Groups and Users can Browse the project or See Source Code.
- If you want all newly created projects to be considered "Private", you can change the default visibility in Administration > Projects > Management (by clicking on the little "pencil" icon in the top right corner of the screen).
- Also, you can go to Administration > Projects > Management to see your newly added application there
Adding your source code to the newly created project and analysing it with SonarQube
After the project has been created you need to assign the source code of the project that you want to analyse to SonarQube. As SonarQube is flexible to analyse projects this can be done in a variety of ways:
Source code only
MANUAL: Adding Source Code Directly to a SonarQube project
Using Gitlab CI
MANUAL: Continuous Integration Setup with GitLab CI and SonarQube
Using a Continuous Integration tool (Bitbucket, ...)
MANUAL: Bitbucket and SonarQube
Getting help
- For more details we recommend to visit the user documentation provided by SonarQube
- WP9 T2 provides the dedicated Slack channel #sonarqube-code-review to help users with any issues they may face