https://github.com/beiertu-mms/sonarqube-report

https://github.com/beiertu-mms/sonarqube-report

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/beiertu-mms/sonarqube-report
• Owner: beiertu-mms
• License: mit
• Created: 2022-08-25T15:00:02.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-08-14T05:01:28.000Z (over 1 year ago)
• Last Synced: 2023-08-14T05:37:10.155Z (over 1 year ago)
• Language: Kotlin
• Size: 225 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sonarqube-report

[![CI](https://github.com/beiertu-mms/cli-app-template/actions/workflows/ci.yaml/badge.svg)](./.github/workflows/ci.yaml)

[![License](https://img.shields.io/github/license/beiertu-mms/sonarqube-report)](./LICENSE)

A simple CLI to fetch SonarQube metric(s) for component(s) and write them to a Markdown file.

## Usage

Build the jar

```sh

./gradlew clean build

```

Use the jar

```sh

java -jar build/libs/sonarqube-report.jar [OPTIONS]

```

Run the jar with the `--help` option or without any options for more information.

## Build requirements

- JDK >= 17

- Gradle >= 8 (optional)

## Installation

**Install**:

The repository contains a simple Makefile, which can be used to build

and copy the built jar and script to the user's bin folder (default: `$HOME/.local/bin`).

```bash

make install

```

**Uninstall**:

The same Makefile also contains an uninstall step,

which will remove the built jar and script from the user's bin folder.

```bash

make uninstall

```

## License

Distributed under the MIT License. See [LICENSE](./LICENSE) for more information.