GoogleCloudPlatform/cloud-opensource-java

Discussion: tool for noticing difference between BOM and explicit dependencies

Open

#1,078 opened on Dec 17, 2019

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Java (80 forks)auto 404
blockeddocumentationenhancementgood first issuehelp wanted

Repository metrics

Stars
 (162 stars)
PR merge metrics
 (PR metrics pending)

Description

Customer issues in b/146130570 are making me think it might be too hard in large projects that extend past GCP to tell which versions can and cannot be set by the BOM. Two ideas:

  1. Docs listing what's covered in the BOM.
  2. An automated tool to suggest changes to a pom.xml when a dependency has an explicit version that is also set by the BOM.

Perhaps an enforcer rule could warn about #2?

DO NOT START IMPLEMENTING THIS. IT HAS NOT BEEN PRIORITIZED OR PLANNED. THIS IS FOR DISCUSSION ONLY

Contributor guide

Research direction
Investigate existing Maven enforcer rules and documentation approaches for listing BOM covered dependencies, focusing on how to automatically detect explicit versions that conflict with BOM managed versions.
Tech stack
java
Domain
backenddevops
Issue type
Research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
MavenJava dependency management
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70