microsoft / microsoft/beachball

Feature: add ability to customize how dependent packages are bumped

Open
#237 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
TypeScript
Stars
815
Forks
93
Avg merge
2d 13h
Merged PRs (30d)
12

Description

From feedback we can do better with the dependent package changes.

1. prompt for dependent bump change type

At the time of calling beachball change, we should prompt user how they would like the dependent packages are going to be bumped. This will default to "patch."

This prompt should respect disabled change types (see also (2))

2. respect disabled change types

We need to add validation during bump phase to check if a version change type is disallowed and fail the bump before files are written on disk.

Sample prompt

beachball change

Change detected in A
Description of the change:
commit msg 1
commit msg 2
commit msg 3

Change type:
patch
minor
major

At this time, these packages depend on A:
B
C
D
E

These should be bumped as:
> patch (default)
minor
major

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

Start with the beachball change and bump entry points described in the issue, tracing how dependent packages and disabled change types are currently handled. Done means the change flow prompts for a dependent bump type with patch as the default, and bump validation rejects disallowed types before files are written.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.