sonarqube action

Sonarqube Github Action

Menggunakan tindakan GitHub ini, pindai kode Anda dengan pemindai Sonarqube untuk mendeteksi bug, kerentanan, dan bau kode dalam lebih dari 20 bahasa pemrograman!

Sonarqube adalah platform open-source yang dikembangkan oleh SonarSource untuk inspeksi kualitas kode yang berkelanjutan untuk melakukan tinjauan otomatis dengan analisis statis kode untuk mendeteksi bug, bau kode, dan kerentanan keamanan pada 20+ bahasa pemrograman.

Persyaratan

• Sonarqube Server.
• Itu saja!

Penggunaan

Alur kerja, biasanya dinyatakan dalam .github/workflows/build.yaml , sepertinya:

 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 }}

Anda dapat mengubah Direktori Basis Analisis dan/atau kunci proyek dengan menggunakan input opsional seperti ini:

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

Input

Ini adalah beberapa parameter input yang didukung dari tindakan.

Parameter	Keterangan	Diperlukan?	Bawaan	Catatan
host	URL Sonarqube Server	?
login	Token login atau otentikasi pengguna sonarqube	?		Diperlukan izin Execute Analysis .
password	Kata sandi yang sesuai dengan nama pengguna login	?		Ini harus dibiarkan kosong jika login adalah token otentikasi.
projectBaseDir	Tetapkan Analisis Direktori Basis Proyek Kustom	?	.
projectKey	Kunci unik proyek ini	?		Karakter yang diizinkan adalah: huruf, angka, - , _ , . dan : dengan setidaknya satu non-digit.
projectName	Nama proyek	?		Ini akan ditampilkan di antarmuka web Sonarqube.
projectVersion	Versi proyek	?
encoding	Pengkodean kode sumber	?	UTF-8

Catatan

Jika Anda memilih untuk mengkonfigurasi metadata proyek dan pengaturan terkait lainnya dalam file sonar-project.properties (harus ditempatkan di dalam direktori dasar, projectBaseDir ) alih-alih menggunakan parameter input, tindakan ini kompatibel dengan pendekatan itu!

Lisensi

Dockerfile dan skrip dan dokumentasi terkait dalam proyek ini dirilis di bawah lisensi MIT.

Gambar kontainer yang dibangun dengan proyek ini termasuk bahan pihak ketiga.