autonomousapps / autonomousapps/dependency-analysis-gradle-plugin

Generate output for `project`/`build` health in machine-readable format

Open
#1,094 5 comments 0 reactions 0 assignees View on GitHub
enhancement help wanted sponsorable
Dominant language
Kotlin
Stars
2.2k
Forks
158
Avg merge
16h 25m
Merged PRs (30d)
46

Description

**Describe the solution you'd like**
New output format for `projectHealth` and `buildHealth`.

In order to support features like [Github Checks](https://docs.github.com/en/rest/checks?apiVersion=2022-11-28), we need the ability to see line-numbers and other metadata associated with files specifically.

In order to reduce the feature request, if we generated `errorformat` outputs, we could hook into tools like [@reviewdog/reviewdog](https://github.com/reviewdog/reviewdog).

**Describe alternatives you've considered**

I wrote up a github action with a python script to parse the `buildHealth.txt` file for outputs: https://github.com/Nava2/dependency-analysis-reviewdog-action. This works OK, but it is brittle and prone to errors as the formats change.

Another, better example than `errorformat` is probably using `sarif` ([Link](https://docs.oasis-open.org/sarif/sarif/v2.0/sarif-v2.0.html))

Contributor guide

Open the contributing guide

Research direction

Start with the projectHealth and buildHealth outputs and compare the existing buildHealth.txt format with the requested machine-readable metadata. Review the errorformat and SARIF references, then define the supported format and verify that it exposes file line numbers and other metadata for GitHub Checks or reviewdog integration.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, kotlin
Domain
build-system
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.