autonomousapps/dependency-analysis-gradle-plugin

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

Open

#1,094 opened on Jan 2, 2024

View on GitHubContributor guide
 (5 comments) (0 reactions) (0 assignees)Kotlin (154 forks)auto 404
enhancementhelp wantedsponsorable

Repository metrics

Stars
 (2,172 stars)
PR merge metrics
 (PR metrics pending)

Description

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

In order to support features like Github Checks, 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.

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)

Contributor guide

Research direction
Investigate the existing projectHealth and buildHealth output formats in the codebase, then research SARIF or errorformat specs to design a new machine readable output. Look at the referenced action for parsing buildHealth.txt to understand current format.
Tech stack
kotlinjava
Domain
build systemci cdtooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
KotlinGradle
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40