Skip to content

Commit

Permalink
Add reference to quality-monitor.
Browse files Browse the repository at this point in the history
  • Loading branch information
uhafner committed Jan 9, 2024
1 parent 38c2f61 commit bfe11e1
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 10 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,18 @@
[![CodeQL](https://github.com/jenkinsci/analysis-model/workflows/CodeQL/badge.svg)](https://github.com/jenkinsci/analysis-model/actions/workflows/codeql.yml)
[![Line Coverage](https://raw.githubusercontent.com/jenkinsci/analysis-model/main/badges/line-coverage.svg)](https://app.codecov.io/gh/jenkinsci/analysis-model)
[![Branch Coverage](https://raw.githubusercontent.com/jenkinsci/analysis-model/main/badges/branch-coverage.svg)](https://app.codecov.io/gh/jenkinsci/analysis-model)
[![Warnings](https://raw.githubusercontent.com/jenkinsci/analysis-model/main/badges/style.svg)](https://github.com/jenkinsci/analysis-model/actions/workflows/quality-monitor.yml)
[![Bugs](https://raw.githubusercontent.com/jenkinsci/analysis-model/main/badges/bugs.svg)](https://github.com/jenkinsci/analysis-model/actions/workflows/quality-monitor.yml)

This library provides a Java object model to read, aggregate, filter, and query static analysis reports.
It is used by [Jenkins' warnings plug-in](https://github.com/jenkinsci/warnings-ng-plugin) to visualize
the warnings of individual builds. Additionally, this library is used by a
[GitHub action](https://github.com/uhafner/autograding-github-action) and [GitLab action](https://github.com/uhafner/autograding-gitlab-action) to autograde student software projects based
on a given set of metrics (unit tests, code and mutation coverage, static analysis warnings).

This library provides a Java API to read, aggregate, filter, and query static analysis reports.
It is used by my [Jenkins' warnings plug-in](https://github.com/jenkinsci/warnings-ng-plugin) to visualize
the warnings of individual builds.

![Jenkins Warnings Plug-in](doc/jenkins.png)

Additionally, this library is used by my additional [Quality Monitor GitHub Action](https://github.com/uhafner/quality-monitor), that monitors the quality of projects based on a configurable set of metrics and gives feedback on pull requests (or single commits) in GitHub.
There are also two additional actions available, to autograde student software projects based
on these metrics: [GitHub Autograding action](https://github.com/uhafner/autograding-github-action) and [GitLab Autograding action](https://github.com/uhafner/autograding-gitlab-action).

![Quality Monitor GitHub Action](doc/quality-monitor.png)

This library consists basically of three separate parts:

Expand Down
2 changes: 1 addition & 1 deletion SUPPORTED-FORMATS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!--- DO NOT EDIT -- Generated at 2023-11-20T16:59:30.040364100 - Run the `main` method of `ParserRegistry` to regenerate after changing parsers -- DO NOT EDIT --->
<!--- DO NOT EDIT -- Generated at 2023-12-23T09:42:52.111874 - Run the `main` method of `ParserRegistry` to regenerate after changing parsers -- DO NOT EDIT --->
# Supported Report Formats

The static analysis model supports the following report formats.
Expand Down
2 changes: 1 addition & 1 deletion doc/dependency-graph.puml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ skinparam rectangle {
BackgroundColor<<runtime>> lightBlue
BackgroundColor<<provided>> lightGray
}
rectangle "analysis-model\n\n11.14.0-SNAPSHOT" as edu_hm_hafner_analysis_model_jar
rectangle "analysis-model\n\n11.14.0" as edu_hm_hafner_analysis_model_jar
rectangle "jsoup\n\n1.17.1" as org_jsoup_jsoup_jar
rectangle "commons-io\n\n2.11.0" as commons_io_commons_io_jar
rectangle "commons-digester3\n\n3.2" as org_apache_commons_commons_digester3_jar
Expand Down
Binary file added doc/jenkins.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/quality-monitor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bfe11e1

Please sign in to comment.