sonarqube action

Sonarqube github动作

使用此GitHub操作，使用Sonarqube扫描仪扫描代码，以20多种编程语言检测错误，漏洞和代码气味！

Sonarqube是Sonarsource开发的一个开源平台，用于连续检查代码质量，以通过对代码进行静态分析进行自动评论，以检测20多种编程语言上的错误，代码气味和安全漏洞。

要求

• 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服务器URL	？
login	Sonarqube用户的登录或身份验证令牌	？		Execute Analysis许可。
password	login用户名随附的密码	？		如果login为身份验证令牌，则应将其空白。
projectBaseDir	设置自定义项目基础目录分析	？	.
projectKey	项目的独特钥匙	？		允许的字符是：字母，数字， - ， _ .和: ，至少一个非数字。
projectName	该项目的名称	？		它将显示在Sonarqube Web界面上。
projectVersion	项目版本	？
encoding	源代码的编码	？	UTF-8

笔记

如果您选择在sonar-project.properties项目中配置项目元数据和其他相关设置。Properties文件（必须放置在基本目录中， projectBaseDir ），而不是使用输入参数，则此操作与该方法兼容！

执照

该项目中的Dockerfile和相关脚本和文档是根据MIT许可发布的。

使用此项目构建的容器图像包括第三方材料。