From bdd9793a33e8fa94e077d74fd95e33208acb37f1 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Tue, 9 Jan 2024 18:17:38 +0100 Subject: [PATCH] Add reference to quality-monitor. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5ecbe66..7314d57 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,14 @@ You can see the results of this action in an [example pull request](https://gith ![Pull request comment](images/pr-comment.png) -Please have a look at my [companion coding style](https://github.com/uhafner/codingstyle) and [Maven parent POM](https://github.com/uhafner/codingstyle-pom) to see how to create Java projects that can be graded using this GitHub action. If you are hosting your project on GitLab, then you might be interested in my [identical GitLab action](https://github.com/uhafner/autograding-gitlab-action) as well. +Please have a look at my [companion coding style](https://github.com/uhafner/codingstyle) and [Maven parent POM](https://github.com/uhafner/codingstyle-pom) to see how to create Java projects that can be graded using this GitHub action. If you want to use this action to visualize the coding quality without creating a grading percentage, then use my additional [Quality Monitor GitHub Action](https://github.com/uhafner/quality-monitor). If you are hosting your project on GitLab, then you might be interested in my [identical GitLab action](https://github.com/uhafner/autograding-gitlab-action) as well. Both actions are inspired by my Jenkins plugins: - [Jenkins Warnings plugin](https://github.com/jenkinsci/warnings-ng-plugin) - [Jenkins Coverage plugin](https://github.com/jenkinsci/coverage-plugin) - [Jenkins Autograding plugin](https://github.com/jenkinsci/autograding-plugin) -They work in the same way but are much more powerful and flexible and show the results additionally in Jenkins' UI. +They work in the same way but are much more powerful and flexible and show the results additionally in Jenkins' UI. Please note that the action works on report files that are generated by other tools. It does not run the tests or static analysis tools itself. You need to run these tools in a previous step of your workflow. See the example below for details. This has the advantage that you can use a tooling you are already familiar with. So the action will run for any programming language that can generate the required report files. There are already more than [one hundred analysis formats](https://github.com/jenkinsci/analysis-model/blob/main/SUPPORTED-FORMATS.md) supported. Code and mutation coverage reports can use the JaCoCo, Cobertura and PIT formats, see the [coverage model](https:://github.com/jenkinsci/coverage-model) for details. Test results can be provided in the [JUnit XML format](https://maven.apache.org/surefire/maven-surefire-plugin/xsd/surefire-test-report.xsd).