microsoft / microsoft/beachball

Feature request to add support for semver metadata

Open
#435 1 comment 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

I could be missing it in the documentation, but it would be great to support metadata from semver 2.0.

I know beachball now supports --tag and it would also be great to support --meta or --meta-data with the supported argument of regex expression or formatted for example to support +yyyymmdd. My goal would be for beachball to automatically handle bumping for this formatted version x.y.z-tag+meta where my meta is formatted as yyyymmdd. So this may become 1.0.0-next+20201027 following Semver precedence.

Beachballs' semver.inc is the file that would include the + to include the semver metadata and if it at minimal supported the yyyymmdd format and possibly later other string formats that would be idea. For Canary, that information can be found https://github.com/microsoft/beachball/blob/master/src/commands/canary.ts to include the option to specify the metadata. Once that's done we'd probably want to set the dist-tag "dev".

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 by reading Beachball's semver.inc and src/commands/canary.ts to trace version bumping and Canary options. Determine how the requested metadata format and option should flow through those entry points, then verify that versions such as 1.0.0-next+20201027 and the requested dev dist-tag are handled as described.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli, 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.