microsoft / microsoft/beachball
Beachball canary isn't documented and doesn't work as would be expected
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 815
- Forks
- 93
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 12
Description
This is going to be a relatively wide ranging issue on the topic of the canary command.
- There isn't any documentation on the
Canarycommand. I had to figure it out for myself after noticing it mentioned once in the docs. - The bump algorithm on canary works a bit weirdly? My packages were on version
0.1.5and I created a minor change. Runningbumplocally increased the version to0.2.0as expected. However, if I undo those changes and instead runcanaryI get0.2.1-pr30.0(where I'm using the PR number from bitbucket). This doesn't seem right, why am I bumping an extra patch version above where I should be? - It might be slightly related to the undocumented nature of the command, but as the bump is not committed back to git, how does
canaryknow to go from.0to.1the next time a version is pushed?
I'm might be willing to look into this and submit a PR, but before I do I'd like my assumptions cleared up, just in case I'm barking up the wrong tree.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the CLI documentation at the linked Bumping and Publishing Options page, then inspect the canary and bump command entry points and reproduce the 0.1.5 to 0.2.1-pr30.0 behavior. Done means the canary versioning behavior is resolved or explained, successive canary increments are understood, and the command is documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, typescript
- Domain
- documentation, release
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100