microsoft / microsoft/beachball

--branch and --since CLI args seem to have same role, used in different places

Open
#617 0 comments 0 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

When running beachball check you have to pass args --branch targetBranch --since targetBranch if you want to scope what is checked to changes since targetBranch. Passing just one of --branch or --since leads to different checks being run on different sets of changes.

This is pretty confusing, and I expect is causing perf regressions for a lot of people (due to unknowingly doing unnecessary checks). We can probably just make these args an alias of each other.

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 check CLI argument handling for --branch and --since, then trace how each value determines the set of changes checked. Done means the two arguments behave as aliases, including when either one is supplied alone, and the resulting checks are consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, typescript
Domain
cli, performance
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.