https://github.com/microsoft/beachball

The Sunniest Semantic Version Bumper
https://github.com/microsoft/beachball

git mp registry semver yarn

Last synced: 3 days ago
JSON representation

The Sunniest Semantic Version Bumper

• Host: GitHub
• URL: https://github.com/microsoft/beachball
• Owner: microsoft
• License: mit
• Created: 2019-06-25T22:48:21.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-01-05T08:03:04.000Z (7 days ago)
• Last Synced: 2025-01-05T21:33:45.744Z (6 days ago)
• Topics: git, mp, registry, semver, yarn
• Language: TypeScript
• Homepage: https://microsoft.github.io/beachball
• Size: 18.9 MB
• Stars: 768
• Watchers: 12
• Forks: 87
• Open Issues: 111
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.json
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

• my-awesome-list - beachball
• awesome-list - beachball
• awesome-javascript - beachball
• awesome-javascript - beachball

README

        


# [beachball](https://microsoft.github.io/beachball/)

the sunniest version bumping tool

## Prerequisites

git and a remote named "origin"

## Usage

```

beachball [command] [options]

```

## Commands

### [change](https://microsoft.github.io/beachball/cli/change.html) (default)

a tool to help create change files in the change/ folder

### [check](https://microsoft.github.io/beachball/cli/check.html)

checks whether a change file is needed for this branch

### [bump](https://microsoft.github.io/beachball/cli/bump.html)

bumps versions as well as generating changelogs

### [publish](https://microsoft.github.io/beachball/cli/publish.html)

bumps, publishes to npm registry (optionally does dist-tags), and pushes changelogs back into the default branch

### [sync](https://microsoft.github.io/beachball/cli/sync.html)

synchronizes published versions of packages from a registry, makes local package.json changes to match what is published

## Options

Some of the most common options are summarized below. For details, see the pages for [CLI options](https://microsoft.github.io/beachball/cli/options.html) and [config file options](https://microsoft.github.io/beachball/overview/configuration.html).

### --config, -c

Explicit configuration file to use instead of the configuration automatically detected by cosmicconfig.

### --registry, -r

registry, defaults to https://registry.npmjs.org

### --tag, -t

- for the publish command: dist-tag for npm publishes

- for the sync command: will use specified tag to set the version

### --branch, -b

target branch from origin (default: as configured in 'git config init.defaultBranch')

### --message, -m

custom message for the checkin (default: applying package updates)

### --no-push

skip pushing changes back to git remote origin

### --no-publish

skip publishing to the npm registry

### --help, -?, -h

show help message

### --yes, -y

skips the prompts for publish

## Examples

```

$ beachball

$ beachball check

$ beachball publish -r http://localhost:4873 -t beta

```

## Notes

### Overriding concurrency

In large monorepos, the Beachball sync process can be time-consuming due to the high number of packages. To optimize performance, you can override the default concurrency (typically 2 or 5) by setting the `NPM_CONCURRENCY` environment variable to a value that best suits your needs.

### API surface

Beachball **does not** have a public API beyond the provided [options](https://microsoft.github.io/beachball/overview/configuration.html). Usage of private APIs is not supported and may break at any time.

If you need to customize something beyond what's currently supported in the options, please open a feature request or talk with the maintainers.