sonarqube action

Sonarqube Github Action

Используя это действие GitHub, сканируйте свой код с помощью сканера Sonarqube, чтобы обнаружить ошибки, уязвимости и кодовые запахи на более чем 20 языках программирования!

Sonarqube-это платформа с открытым исходным кодом, разработанную Sonarsource для непрерывной проверки качества кода для проведения автоматических обзоров со статическим анализом кода для обнаружения ошибок, запахов кода и уязвимостей безопасности на более чем языках программирования.

Требования

• Сервер Sonarqube.
• Вот и все!

Использование

Рабочий процесс, обычно объявляемый в .github/workflows/build.yaml , выглядит как:

 on :
  # Trigger analysis when pushing in master or pull requests, and when creating
  # a pull request. 
  push :
    branches :
      - master
  pull_request :
      types : [opened, synchronize, reopened]

name : SonarQube Scan
jobs :
  sonarqube :
    name : SonarQube Trigger
    runs-on : ubuntu-latest
    steps :
    - name : Checking out
      uses : actions/checkout@master
      with :
        # Disabling shallow clone is recommended for improving relevancy of reporting
        fetch-depth : 0
    - name : SonarQube Scan
      uses : kitabisa/[email protected]
      with :
        host : ${{ secrets.SONARQUBE_HOST }}
        login : ${{ secrets.SONARQUBE_TOKEN }}

Вы можете изменить базовый каталог анализа и/или ключ проекта, используя необязательный ввод, как это:

 uses : kitabisa/sonarqube-action@master
with :
  host : ${{ secrets.SONARQUBE_HOST }}
  login : ${{ secrets.SONARQUBE_TOKEN }}
  projectBaseDir : " src/ "
  projectKey : " my-custom-project "

Входные данные

Это некоторые из поддерживаемых входных параметров действия.

Параметр	Описание	Необходимый?	По умолчанию	Примечание
host	Sonarqube Server URL	?
login	Вход или знак аутентификации пользователя Sonarqube	?		Требуется разрешение Execute Analysis .
password	Пароль, который идет с именем пользователя login	?		Это должно быть оставлено пустым, если login является токеном аутентификации.
projectBaseDir	Установить пользовательский анализ базовых каталогов проекта	?	.
projectKey	Уникальный ключ проекта	?		Разрешенные символы: буквы, числа, - , _ , . и : по крайней мере, с одним незначным.
projectName	Название проекта	?		Он будет отображаться на веб -интерфейсе Sonarqube.
projectVersion	Версия проекта	?
encoding	Кодирование исходного кода	?	UTF-8

Примечание

Если вы решите настроить метаданные проекта и другие связанные настройки в файле sonar-project.properties (должны быть размещены в базовом каталоге, projectBaseDir ) вместо использования входных параметров, это действие совместимо с этим подходом!

Лицензия

Dockerfile и связанные сценарии и документация в этом проекте выпускаются по лицензии MIT.

Контейнерные изображения, построенные с этим проектом, включают сторонние материалы.