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	プロジェクトのユニークなキー	？		許可された文字は次のとおりです。文字、数字、 - 、 _ .および:少なくとも1つの非桁を伴う。
projectName	プロジェクトの名前	？		Sonarqube Webインターフェイスに表示されます。
projectVersion	プロジェクトバージョン	？
encoding	ソースコードのエンコード	？	UTF-8

注記

sonar-project.propertiesファイル（ベースprojectBaseDir内に配置する必要がある）でプロジェクトメタデータおよびその他の関連設定を設定することを選択した場合、入力パラメーターを使用する代わりに、このアクションはそのアプローチと互換性があります。

ライセンス

このプロジェクトのDockerfileと関連するスクリプトとドキュメントは、MITライセンスの下でリリースされます。

このプロジェクトで構築されたコンテナ画像には、サードパーティの資料が含まれています。