Create an immutable and exportable component snapshot, tagged with a release version.
$bit tag [component-patterns...]
$bit t [component-patterns...]
Additional Notes
if no patterns are provided, it will tag all new and modified components.
if patterns are entered, you can specify a version per pattern using "@" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major
Arguments
| Argument | Description | Required |
|---|---|---|
| component-patterns... | component name, component id, or component pattern. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and "!" to exclude. e.g. "ui/**, !ui/button". use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.. By default, all new and modified are tagged. |
Options
| Option | Option Alias | Description | Value Type |
|---|---|---|---|
| --message | -m | a log message describing latest changes | string |
| --unmodified | -u | include unmodified components (by default, only new and modified components are tagged) | boolean |
| --editor | - | open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim). | string |
| --ver | -v | tag with the given version | string |
| --increment | -l | options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch | string |
| --prerelease-id | - | prerelease identifier (e.g. "dev" to get "1.0.0-dev.1") | string |
| --patch | -p | syntactic sugar for "--increment patch" | boolean |
| --minor | - | syntactic sugar for "--increment minor" | boolean |
| --major | - | syntactic sugar for "--increment major" | boolean |
| --pre-release | - | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` | string |
| --snapped | - | tag only components whose head is a snap (not a tag) | boolean |
| --unmerged | - | complete a merge process by tagging the unmerged components | boolean |
| --skip-tests | - | skip running component tests during tag process | boolean |
| --skip-auto-tag | - | skip auto tagging dependents | boolean |
| --soft | - | do not persist. only keep note of the changes to be made | boolean |
| --persist | - | persist the changes generated by --soft tag. by default, run the build pipeline, unless "skip-build" is provided | string |
| --disable-tag-pipeline | - | skip the tag pipeline to avoid publishing the components | boolean |
| --force-deploy | - | DEPRECATED. use --ignore-build-error instead | boolean |
| --ignore-build-errors | - | proceed to tag pipeline even when build pipeline fails | boolean |
| --rebuild-deps-graph | - | do not reuse the saved dependencies graph, instead build it from scratch | boolean |
| --increment-by | - | (default to 1) increment semver flag (patch/minor/major) by. e.g. incrementing patch by 2: 0.0.1 -> 0.0.3. | string |
| --ignore-issues | -i | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: [MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "*". | string |
| --ignore-newest-version | -I | allow tagging even when the component has newer versions e.g. for hotfixes (default = false) | boolean |
| --fail-fast | - | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) | boolean |
| --build | -b | locally run the build pipeline (i.e. not via rippleCI) and complete the tag | boolean |
| --all | -a | DEPRECATED (not needed anymore, it is the default now). tag all new and modified components | string |
| --scope | -s | DEPRECATED (use "--unmodified" instead). tag all components of the local scope | string |
| --force | -f | DEPRECATED (use "--skip-tests", "--ignore-build-errors" or "--unmodified" instead). force-tag even if tests are failing and even when component has not changed | boolean |
| --disable-deploy-pipeline | - | DEPRECATED. use --disable-tag-pipeline instead | boolean |
