set-up-sonar

Setup a new project in SonarCloud from CI

Thanks to the SonarCloud team, it's already easy to integrate it into your GitHub workflow using the official action, but some manual work is still required before you have your first analysis done.

This action offers an intuitive way to prepare your project to be analyzed for the first time directly from your CI pipeline. It may help you to build templates or reusable workflows integrated with SonarCloud without leaving GitHub.

Requirements

• Have an account in SonarCloud;
• A SonarCloud Api token;

Usage

First, create a secret with your SonarCloud Api Token following this guide, and then add this action to your workflow like below:

- name: Setup SonarCloud
  uses: nelsoncanarinho/setup-sonar@v1.0.0
  with:
    SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

This will create a new project in your SonarCloud organization using your repo name as the project key. It'll also rename Sonar's default branch to match the GitHub default (main).

The action will always output a SONAR_ORGANIZATION and SONAR_PROJECT_KEY, but it creates the project only once, as expected.

A standard workflow would look like this:

on:
  push:
    branches:
      - main
jobs:
  sonarcloud:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0

      - name: Setup Sonar
        id: setupSonar
        uses: nelsoncanarinho/setup-sonar@v1.0.0
        with:
          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

      - name: SonarCloud Scan
        uses: sonarsource/sonarcloud-github-action@master
        with:
          args: >
            -Dsonar.organization=${{steps.setupSonar.outputs.SONAR_ORGANIZATION}}
            -Dsonar.projectKey=${{steps.setupSonar.outputs.SONAR_PROJECT_KEY}}
            -Dsonar.qualitygate.wait=true ## Failed analysis will fail the action
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

Action Inputs

SONAR_PROJECT_NAME:
  description: 'Sonar custom name for the project. Default is the repo name.'
SONAR_PROJECT_KEY:
  description: 'Sonar custom project key. Default is the repo name.'
  required: false
SONAR_ORGANIZATION:
  description: 'Name of the organization configured in Sonar. Default is the repo owner. Be aware that your SONAR_TOKEN must have privileges to create projects in the provided organization.'
  required: false
SONAR_DEFAULT_BRANCH:
  description: 'Name of the main branch of the project'
  required: false
  default: main
SONAR_TOKEN:
  description: 'Sonar token used to integrate with SonarCloud api.'
  required: true

Action Outputs

 SONAR_ORGANIZATION:
    description: 'Sonar organization for the created project'
  SONAR_PROJECT_KEY:
    description: 'Sonar project key for the created project'