neil/sonarqube-action
1
0
Fork 0
mirror of https://github.com/kitabisa/sonarqube-action.git synced 2025-11-01 05:34:18 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Dwi Siswanto 2022-06-16 12:28:13 +07:00
parent 9d60bddfc9
commit 7e63816c89
1 changed files with 18 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -16,14 +16,26 @@ SonarQube is an open-source platform developed by SonarSource for continuous ins
The workflow, usually declared in `.github/workflows/build.yaml`, looks like: The workflow, usually declared in `.github/workflows/build.yaml`, looks like:
```yaml ```yaml
on: push on:
name: Main Workflow # 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: jobs:
sonarQubeTrigger: sonarqube:
name: SonarQube Trigger name: SonarQube Trigger
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@master - name: Checking out
uses: actions/checkout@master
with:
# Disabling shallow clone is recommended for improving relevancy of reporting
fetch-depth: 0
- name: SonarQube Scan - name: SonarQube Scan
uses: kitabisa/sonarqube-action@v1.1.2 uses: kitabisa/sonarqube-action@v1.1.2
with: with:
@ -53,9 +65,10 @@ These are some of the supported input parameters of action.
- `projectKey` - The project's unique key _(allowed characters are: letters, numbers, `-`, `_`, `.` and `:`, with at least one non-digit)_. - `projectKey` - The project's unique key _(allowed characters are: letters, numbers, `-`, `_`, `.` and `:`, with at least one non-digit)_.
- `projectName` - Name of the project that will be displayed on the SonarQube web interface. - `projectName` - Name of the project that will be displayed on the SonarQube web interface.
- `projectVersion` - The project version. - `projectVersion` - The project version.
- `encoding` - Encoding of the source code. Default is UTF-8.
> **Note**: > **Note**:
> If you're thinking of setting project metadata & other related things in a **`sonar-project.properties`** configuration file (must be declared in the base directory _`projectBaseDir`_) instead of going through the [input parameters](#inputs), this action supports that! > If you're thinking of setting project metadata & other related things in a **`sonar-project.properties`** configuration file _(must be declared in the base directory `projectBaseDir`)_ instead of going through the [input parameters](#inputs), this action supports that!
## License ## License