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許可發布的。

使用此項目構建的容器圖像包括第三方材料。