Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/balrok/qualityannotate
Program to annotate quality issues on your pull request.
https://github.com/balrok/qualityannotate
Last synced: 2 days ago
JSON representation
Program to annotate quality issues on your pull request.
- Host: GitHub
- URL: https://github.com/balrok/qualityannotate
- Owner: balrok
- Created: 2023-10-15T17:16:32.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2023-11-05T16:46:12.000Z (about 1 year ago)
- Last Synced: 2023-11-05T17:33:52.416Z (about 1 year ago)
- Language: Java
- Size: 378 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Quality-Annotate
Program to annotate quality issues on your pull request.
The implementation tries to be variable within the two dimensions of:
* Code-Hoster (bitbucket, gitlab, github)
* Quality-Tool (Sonarqube, Klocwork)
| | Bitbucket | Gitlab | Github |
|-----------|-----------|----------|----------|
| Sonarqube | ❌ | ❌ | [✅](./docs/github.md) |
| ??? | ❌ | ❌ | ❌ |
Since it is a commandline application it can also be integrated in various ci-systems. Please refer to the sample ci
configs:
* ❌ Jenkins
* ❌ Gitlab-CI
* ❌ Github-Actions
## Installing
Download the program from releases. Put the application.yml from the release page
into `$HOME/.config/qualityannotate.yml`.
Then run ./qualityannotate sonarqube github
## Developing
You can run your application in dev mode that enables live coding using:
```shell script
./gradlew quarkusDev --quarkus-args="sonarqube github"
```
If you want to use intellij, there is a bug with the quarkus-args, so use the jvm-args
`-Dquarkus.args="sonarqube github"` for the `quarkusDev` job.
## Codestyle
Codestyle is setup using `./gradlew spotlessApply`.
[Intellij requires the eclipse code-formatter plugin](https://plugins.jetbrains.com/plugin/6546-eclipse-code-formatter/versions).
Configs are `./config/code-formatter/eclipse.importorder` and `./config/code-formatter/eclipse.xml`.
## Pre-Commit hook
```sh
pip install pre-commit
pre-commit install
pre-commit install --hook-type commit-msg
```
## Creating a native executable / uber jar
```sh
# create a native executable
./gradlew build -Dquarkus.package.type=native
# create a native executable using a docker container
./gradlew build -Dquarkus.package.type=native -Dquarkus.native.container-build=true
# create an uber jar
./gradlew build -Dquarkus.package.type=uber-jar
```