https://github.com/javiertuya/sonarqube-action

Scans a java maven project with SonarQube, restores artifacts and checks quality gate
https://github.com/javiertuya/sonarqube-action

github-action java maven quality-gate sonarcloud sonarqube

Last synced: about 4 hours ago
JSON representation

Scans a java maven project with SonarQube, restores artifacts and checks quality gate

• Host: GitHub
• URL: https://github.com/javiertuya/sonarqube-action
• Owner: javiertuya
• License: mit
• Created: 2023-06-16T17:40:59.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-03T06:01:47.000Z (4 months ago)
• Last Synced: 2024-10-03T10:34:17.203Z (about 2 months ago)
• Topics: github-action, java, maven, quality-gate, sonarcloud, sonarqube
• Homepage:
• Size: 27.3 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SonarQube Maven Scan Action

This action scans a java maven project with SonarQube. Features:

- Does not require any change in the `pom.xml`, all configuration is read from `sonar-project.properties`

- Cache setup and compilation

- Optional restore of one or more artifacts to send additional info to SonarQube (e.g. coverage)

- Check the quality gate

## Inputs

- `github-token` *(Required)*: Token to access GitHub (needed to check the quality gate)

- `sonar-token` *(Required)*: Token to access SonarQube

- `sonar-host-url` *(Default to https://sonarcloud.io)*: Tells the scanner where SonarQube is hosted

- `working-directory` *(Default to root directory)*: The name of the working directory from which the scan is executed

- `java-version` *(Default 17)*: Java version used run the scans (JDK 17 is the minium required by SonarCloud)

- `restore-artifact-name`, Where `` is a number (1 to 6). Optional name of an artifact to be restored to send additional info to SonarQube (e.g. coverage reports)

- `restore-artifact-path` *(Default to the `working-directory`)*: Path where `restore-artifact-name` will be restored (relative to the working directory)'

## Example usage

```yaml

      - uses: javiertuya/sonarqube-action@main

        with: 

          github-token: ${{ secrets.GITHUB_TOKEN }}

          sonar-token: ${{ secrets.SONAR_TOKEN }}

          restore-artifact-name1: "test-coverage-files"

```