beachball

the sunniest version bumping tool

Prerequisites

git and a remote named "origin"

Usage

``beachball [command] [options]`

`Commands`

`$3`

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

`$3`

checks whether a change file is needed for this branch

`$3`

bumps versions as well as generating changelogs

`$3`

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

`$3`

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 and config file options.

`$3`

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

`$3`

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

`$3`

- for the publish command: dist-tag for npm publishes - for the sync command: will use specified tag to set the version

`$3`

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

`$3`

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

`$3`

skip pushing changes back to git remote origin

`$3`

skip publishing to the npm registry

`$3`

show help message

`$3`

skips the prompts for publish

`Examples`

`$ beachball

$ beachball check

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

`Notes`

`$3`

In large monorepos, the process of fetching versions for sync or before publishing can be time-consuming due to the high number of packages. To optimize performance, you can override the concurrency for fetching from the registry by setting options.npmReadConcurrency (default: 5). You can also increase concurrency for hook calls and publish operations via options.concurrency` (default: 1; respects topological order).

$3

Beachball does not have a public API beyond the provided options. 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.

beachball

the sunniest version bumping tool

Prerequisites

git and a remote named "origin"

Usage

``beachball [command] [options]`

`Commands`

`$3`

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

`$3`

checks whether a change file is needed for this branch

`$3`

bumps versions as well as generating changelogs

`$3`

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

`$3`

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 and config file options.

`$3`

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

`$3`

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

`$3`

- for the publish command: dist-tag for npm publishes - for the sync command: will use specified tag to set the version

`$3`

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

`$3`

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

`$3`

skip pushing changes back to git remote origin

`$3`

skip publishing to the npm registry

`$3`

show help message

`$3`

skips the prompts for publish

`Examples`

`$ beachball

$ beachball check

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

`Notes`

`$3`

$3

Beachball does not have a public API beyond the provided options. 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.