typelevel / typelevel/sbt-typelevel

A way to detect breaking dependency updates

Open
#185 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help wanted question
Dominant language
Scala
Stars
185
Forks
62
PR merge metrics
No merged PRs in 30d

Description

If you break bincompat without bumping your base version, MiMa will stop you in your tracks.

But, if you take on a breaking version bump in a dependency without otherwise breaking binary-compatibility, there's nothing to stop you.

There seems to be some confusion about this, but I'm pretty sure both these situations necessitate breaking bumps.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue concerns MiMa checks and dependency version bumps, but names no files or tests. Start by locating the repository's MiMa and dependency-update configuration, then reproduce a breaking dependency bump without another binary-compatibility break. Done means the build detects and rejects that case alongside existing bincompat checks.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.