Skip to content

Commit

Permalink
change version in README manually - add badges (#22)
Browse files Browse the repository at this point in the history
  • Loading branch information
gitricko authored Jun 27, 2024
1 parent ff5c86c commit 78788ec
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
[![Test](https://github.com/gitricko/sonarless/actions/workflows/test.yml/badge.svg)](https://github.com/gitricko/sonarless/actions/workflows/test.yml)
[![Codacy](https://github.com/gitricko/sonarless/actions/workflows/codacy.yml/badge.svg)](https://github.com/gitricko/sonarless/actions/workflows/codacy.yml)
![GitHub License](https://img.shields.io/github/license/gitricko/sonarless)
![GitHub Release](https://img.shields.io/github/v/release/gitricko/sonarless)
![GitHub commits since latest release](https://img.shields.io/github/commits-since/gitricko/sonarless/latest)

# Sonarless v1
# Sonarless v1.1

This developer-friendly CLI and GitHub Action enable SonarQube scanning for your repository without the need for a dedicated hosted SonarQube server. It starts a SonarQube Docker instance, allowing developers to scan code, check results, and generate a JSON metrics file for automation. This ensures you can easily assess and maintain the quality of your code.

Expand Down Expand Up @@ -59,7 +62,7 @@ This CLI works perfectly with Github CodeSpace

<!-- start usage -->
```yaml
- uses: gitricko/sonarless@v1
- uses: gitricko/sonarless@v1.1
with:
# Folder path to scan from git-root
# Default: .
Expand Down Expand Up @@ -97,7 +100,7 @@ jobs:
uses: actions/checkout@v4

- name: Sonarless Scan
uses: gitricko/sonarless@v1
uses: gitricko/sonarless@v1.1
```
## Scan particular folder from git root directory
Expand All @@ -111,7 +114,7 @@ jobs:
uses: actions/checkout@v4

- name: Sonarless Scan
uses: gitricko/sonarless@v1
uses: gitricko/sonarless@v1.1
with:
sonar-source-path: 'src'
```
Expand All @@ -127,7 +130,7 @@ jobs:
uses: actions/checkout@v4

- name: Sonarless Scan
uses: gitricko/sonarless@v1
uses: gitricko/sonarless@v1.1
with:
sonar-source-path: 'src'
sonar-metrics-path: './sonar-mymetrics.json'
Expand All @@ -151,7 +154,7 @@ jobs:
uses: actions/checkout@v4
- name: Sonarless Scan
uses: gitricko/sonarless@v1
uses: gitricko/sonarless@v1.1
with:
sonar-instance-port: '1234'
```
Expand Down

0 comments on commit 78788ec

Please sign in to comment.