@teambit/harmony.content.cli-reference 2.0.1131 → 2.0.1133
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cli-reference.docs.mdx +1 -1
- package/cli-reference.json +41 -25
- package/cli-reference.mdx +84 -82
- package/dist/cli-reference.docs.mdx +1 -1
- package/dist/cli-reference.json +41 -25
- package/dist/cli-reference.mdx.js +1 -1
- package/dist/cli-reference.mdx.js.map +1 -1
- package/dist/{preview-1784143869906.js → preview-1784214251112.js} +2 -2
- package/package.json +2 -2
package/cli-reference.mdx
CHANGED
|
@@ -168,9 +168,9 @@ rarely used for manual aspect management as most aspects are configured automati
|
|
|
168
168
|
| `aspect-id` | the aspect's component id |
|
|
169
169
|
| `config` | the aspect config. enter the config as a stringified JSON (e.g. `{"foo":"bar"}` ). when no config is provided, an aspect is set with an empty config ({}). |
|
|
170
170
|
|
|
171
|
-
| **Option** | **Option alias** | **Description**
|
|
172
|
-
| ---------- | :--------------: |
|
|
173
|
-
| `--merge` | `-m` | merge with an existing config if
|
|
171
|
+
| **Option** | **Option alias** | **Description** |
|
|
172
|
+
| ---------- | :--------------: | ----------------------------------------------------------------------------------------------- |
|
|
173
|
+
| `--merge` | `-m` | merge with an existing config if exists. (by default, it replaces overlapping existing configs) |
|
|
174
174
|
|
|
175
175
|
### aspect unset
|
|
176
176
|
|
|
@@ -439,25 +439,26 @@ Resolves the lane name from --lane or the current Git branch, validates it, and
|
|
|
439
439
|
**Description**: Tags and exports new semantic versions after merging a PR to main.
|
|
440
440
|
By default, bumps patch versions when merging to main. If specific configuration variables are set, it can use commit messages or explicit flags to determine the version bump. Runs install, tag, build, and export, then archives the remote lane and syncs lockfiles. Use in merge-to-main CI pipelines to publish releases.
|
|
441
441
|
|
|
442
|
-
| **Option** | **Option alias** | **Description**
|
|
443
|
-
| --------------------------------------- | :--------------: |
|
|
444
|
-
| `--message <message>` | `-m` | If set, use it as the tag message, if not, try and grab from git-commit-message
|
|
445
|
-
| `--build` | `-b` | Set to true to build the app locally, false (default) will build on Ripple CI
|
|
446
|
-
| `--strict` | `-s` | Set to true to fail on warnings as well as errors, false (default) only fails on errors
|
|
447
|
-
| `--increment <level>` | `-l` | options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch
|
|
448
|
-
| `--prerelease-id <id>` | | prerelease identifier (e.g. "dev" to get "1.0.0-dev.1")
|
|
449
|
-
| `--patch` | `-p` | syntactic sugar for "--increment patch"
|
|
450
|
-
| `--minor` | | syntactic sugar for "--increment minor"
|
|
451
|
-
| `--major` | | syntactic sugar for "--increment major"
|
|
452
|
-
| `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>`
|
|
453
|
-
| `--increment
|
|
454
|
-
| `--
|
|
455
|
-
| `--
|
|
456
|
-
| `--
|
|
457
|
-
| `--
|
|
458
|
-
| `--
|
|
459
|
-
| `--
|
|
460
|
-
| `--
|
|
442
|
+
| **Option** | **Option alias** | **Description** |
|
|
443
|
+
| --------------------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
444
|
+
| `--message <message>` | `-m` | If set, use it as the tag message, if not, try and grab from git-commit-message |
|
|
445
|
+
| `--build` | `-b` | Set to true to build the app locally, false (default) will build on Ripple CI |
|
|
446
|
+
| `--strict` | `-s` | Set to true to fail on warnings as well as errors, false (default) only fails on errors |
|
|
447
|
+
| `--increment <level>` | `-l` | options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch |
|
|
448
|
+
| `--prerelease-id <id>` | | prerelease identifier (e.g. "dev" to get "1.0.0-dev.1") |
|
|
449
|
+
| `--patch` | `-p` | syntactic sugar for "--increment patch" |
|
|
450
|
+
| `--minor` | | syntactic sugar for "--increment minor" |
|
|
451
|
+
| `--major` | | syntactic sugar for "--increment major" |
|
|
452
|
+
| `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` |
|
|
453
|
+
| `--auto-tag-increment <level>` | | the increment level to use for auto-tagged dependents. options are: [major, premajor, minor, preminor, patch, prepatch, prerelease]. by default, dependents are bumped by a patch, unless --increment is one of [prepatch, prerelease, preminor, premajor], which they follow. note that dependents are auto-tagged transitively, so the entire dependents graph is bumped by this level |
|
|
454
|
+
| `--increment-by <number>` | | (default to 1) increment semver flag (patch/minor/major) by. e.g. incrementing patch by 2: 0.0.1 -> 0.0.3. |
|
|
455
|
+
| `--versions-file <path>` | | path to a file containing component versions. format: "component-id: version" |
|
|
456
|
+
| `--verbose` | | show verbose output |
|
|
457
|
+
| `--auto-merge-resolve <merge-strategy>` | `-r` | in case of merge conflict during checkout, resolve according to the provided strategy: [ours, theirs, manual] |
|
|
458
|
+
| `--force-theirs` | | do not merge during checkout, just overwrite with incoming files |
|
|
459
|
+
| `--lane-name <name>` | | specify the lane name to delete after merge (auto-detected if not provided) |
|
|
460
|
+
| `--skip-push` | | skip pushing the changes to the remote repository (useful when CI handles the push separately) |
|
|
461
|
+
| `--no-bitmap-commit` | | skip the post-tag git add/commit/push entirely. The new versions still land in the scope, but no .bitmap (or lockfile) commit is created on the default branch. Pair with `bitmapAutoSync: true` in workspace.jsonc so developers auto-sync their local .bitmap on the first bit command after `git pull`. |
|
|
461
462
|
|
|
462
463
|
---
|
|
463
464
|
|
|
@@ -601,7 +602,7 @@ to remove components from your local workspace only, use "bit remove" instead.
|
|
|
601
602
|
| `--range <string>` | | EXPERIMENTAL. enter a Semver range to delete specific tags (cannot be used for snaps). see https://www.npmjs.com/package/semver#ranges for the range syntax |
|
|
602
603
|
| `--silent` | `-s` | skip confirmation |
|
|
603
604
|
| `--hard` | | NOT-RECOMMENDED. delete a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents. |
|
|
604
|
-
| `--force` | `-f` | relevant for --hard. allow the deletion even if used as a dependency. WARNING: components that depend on this component will
|
|
605
|
+
| `--force` | `-f` | relevant for --hard. allow the deletion even if used as a dependency. WARNING: components that depend on this component will be corrupted |
|
|
605
606
|
| `--snaps <string>` | | comma-separated list of snap hashes to mark as deleted (e.g. --snaps "hash1,hash2,hash3") |
|
|
606
607
|
|
|
607
608
|
---
|
|
@@ -917,10 +918,10 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
917
918
|
|
|
918
919
|
`bit eject-conf <pattern>`
|
|
919
920
|
|
|
920
|
-
| **Option** | **Option alias** | **Description**
|
|
921
|
-
| ------------- | :--------------: |
|
|
922
|
-
| `--propagate` | `-p` | mark propagate true in the config file, so that component.json configs will be
|
|
923
|
-
| `--override` | `-o` | override file if
|
|
921
|
+
| **Option** | **Option alias** | **Description** |
|
|
922
|
+
| ------------- | :--------------: | ------------------------------------------------------------------------------------------------------------ |
|
|
923
|
+
| `--propagate` | `-p` | mark propagate true in the config file, so that component.json configs will be merged with workspace configs |
|
|
924
|
+
| `--override` | `-o` | override the file if it exists |
|
|
924
925
|
|
|
925
926
|
---
|
|
926
927
|
|
|
@@ -970,8 +971,8 @@ environments control how components are built, tested, linted, and deployed.
|
|
|
970
971
|
|
|
971
972
|
**Description**: un-sets an env from components that were previously set by "bit env set" or by a component template
|
|
972
973
|
keep in mind that this doesn't remove envs that are set via variants.
|
|
973
|
-
|
|
974
|
-
the purpose of this command is to reset previously assigned envs to either allow variants configure the env or use the base node env.
|
|
974
|
+
it only removes envs that appear in the .bitmap file, which were previously configured via "bit env set".
|
|
975
|
+
the purpose of this command is to reset previously assigned envs to either allow variants to configure the env or use the base node env.
|
|
975
976
|
you can use a `<pattern>` for multiple component ids, such as `bit env unset "org.scope/utils/**"`.
|
|
976
977
|
use comma to separate patterns and '!' to exclude. e.g. 'ui/\*\*, !ui/button'
|
|
977
978
|
use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.
|
|
@@ -1141,7 +1142,7 @@ by default shows only workspace components; use --include-dependencies for full
|
|
|
1141
1142
|
| **Option** | **Option alias** | **Description** |
|
|
1142
1143
|
| ------------------------ | :--------------: | ------------------------------------------------------------------------------------------------------------ |
|
|
1143
1144
|
| `--remote [remoteName]` | `-r` | remote name (name is optional, leave empty when id is specified) |
|
|
1144
|
-
| `--layout <name>` | |
|
|
1145
|
+
| `--layout <name>` | | Graphviz layout. default to "dot". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi] |
|
|
1145
1146
|
| `--png` | | save the graph as a png file instead of svg. requires "graphviz" to be installed |
|
|
1146
1147
|
| `--cycles` | | generate a graph of cycles only |
|
|
1147
1148
|
| `--include-local-only` | | DEPRECATED: include only the components in the workspace (or local scope). This is now the default behavior. |
|
|
@@ -1193,12 +1194,12 @@ without arguments, fetches all workspace components' latest versions from their
|
|
|
1193
1194
|
| `--dependents` | | import components found while traversing from the imported components upwards to the workspace components |
|
|
1194
1195
|
| `--dependents-via <string>` | | same as --dependents except the traversal must go through the specified component. to specify multiple components, wrap with quotes and separate by a comma |
|
|
1195
1196
|
| `--dependents-all` | | same as --dependents except not prompting for selecting paths but rather selecting all paths and showing final confirmation before importing |
|
|
1196
|
-
| `--dependents-dry-run` | | DEPRECATED. (this is the default now). same as --dependents, except it prints the found dependents and
|
|
1197
|
+
| `--dependents-dry-run` | | DEPRECATED. (this is the default now). same as --dependents, except it prints the found dependents and waits for confirmation before importing them |
|
|
1197
1198
|
| `--silent` | | no prompt for --dependents/--dependents-via flags |
|
|
1198
1199
|
| `--filter-envs <envs>` | | only import components that have the specified environment (e.g., "teambit.react/react-env") |
|
|
1199
1200
|
| `--save-in-lane` | | when checked out to a lane and the component is not on the remote-lane, save it in the lane (defaults to save on main) |
|
|
1200
1201
|
| `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |
|
|
1201
|
-
| `--fetch-deps` | | fetch dependencies (bit components) objects to the local scope, but
|
|
1202
|
+
| `--fetch-deps` | | fetch dependencies (bit components) objects to the local scope, but don't add to the workspace. Useful to resolve errors about missing dependency data |
|
|
1202
1203
|
| `--write-deps <target>` | | write all workspace component dependencies to the specified target ("package.json" or "workspace.jsonc"), resolving conflicts by picking the ranges that match the highest versions |
|
|
1203
1204
|
| `--track-only` | | do not write any component files, just create .bitmap entries of the imported components. Useful when the files already exist and just want to re-add the component to the bitmap |
|
|
1204
1205
|
| `--include-deprecated` | | when importing with patterns, include deprecated components (default to exclude them) |
|
|
@@ -1225,7 +1226,7 @@ supports various reset options to recover from corrupted state or restart from s
|
|
|
1225
1226
|
| `--no-package-json` | | do not generate package.json |
|
|
1226
1227
|
| `--reset` | `-r` | write missing or damaged Bit files |
|
|
1227
1228
|
| `--reset-new` | | reset .bitmap file as if the components were newly added and remove all model data (objects) |
|
|
1228
|
-
| `--reset-lane-new` | | same as reset-new, but it only resets components
|
|
1229
|
+
| `--reset-lane-new` | | same as reset-new, but it only resets components belonging to lanes. main components are left intact |
|
|
1229
1230
|
| `--reset-hard` | | delete all Bit files and directories, including Bit configuration, tracking and model data. Useful for re-starting workspace from scratch |
|
|
1230
1231
|
| `--reset-scope` | | removes local scope (.bit or .git/bit). tags/snaps that have not been exported will be lost. workspace is left intact |
|
|
1231
1232
|
| `--default-directory <default-directory>` | `-d` | set the default directory pattern to import/create components into |
|
|
@@ -1264,7 +1265,7 @@ automatically imports components, compiles components, links to node_modules, an
|
|
|
1264
1265
|
| `--skip-compile` | | do not compile components |
|
|
1265
1266
|
| `--skip-write-config-files` | | do not write config files (such as eslint, tsconfig, prettier, etc...) |
|
|
1266
1267
|
| `--add-missing-deps` | `-a` | install all missing dependencies |
|
|
1267
|
-
| `--skip-unavailable` | | when adding missing dependencies, skip those that are not found in the
|
|
1268
|
+
| `--skip-unavailable` | | when adding missing dependencies, skip those that are not found in the registry |
|
|
1268
1269
|
| `--add-missing-peers` | | install all missing peer dependencies |
|
|
1269
1270
|
| `--recurring-install` | | automatically run install again if there are non loaded old envs in your workspace |
|
|
1270
1271
|
| `--no-optional [noOptional]` | | do not install optional dependencies (works with pnpm only) |
|
|
@@ -1340,7 +1341,7 @@ without a sub-command, lists all available lanes.
|
|
|
1340
1341
|
| `--workspace-only` | | checkout only the components in the workspace to the selected lane |
|
|
1341
1342
|
| `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components |
|
|
1342
1343
|
| `--pattern <component-pattern>` | `-p` | switch only the lane components matching the specified component-pattern. only works when the workspace is empty component name, component id, component pattern, or relative directory path. 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 '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1343
|
-
| `--alias <string>` | `-n` | relevant when the specified lane is a remote lane. create a local alias for the lane (
|
|
1344
|
+
| `--alias <string>` | `-n` | relevant when the specified lane is a remote lane. create a local alias for the lane (doesn't affect the lane's name on the remote) |
|
|
1344
1345
|
| `--verbose` | | display detailed information about components that legitimately were not switched |
|
|
1345
1346
|
| `--json` | `-j` | return the output as JSON |
|
|
1346
1347
|
| `--branch` | | create and checkout a new git branch named after the lane |
|
|
@@ -1561,9 +1562,9 @@ run "bit lane history" to find history-ids
|
|
|
1561
1562
|
**Usage**: `lane revert <history-id>`
|
|
1562
1563
|
|
|
1563
1564
|
**Description**: revert to a previous history of the current lane. see also "bit lane checkout"
|
|
1564
|
-
revert is similar to "lane checkout", but it keeps the versions and only
|
|
1565
|
+
revert is similar to "lane checkout", but it keeps the versions and only changes the files.
|
|
1565
1566
|
choose one or the other based on your needs.
|
|
1566
|
-
if you want to continue working on this lane and
|
|
1567
|
+
if you want to continue working on this lane and need the changes from the history to be the head, then use "lane revert".
|
|
1567
1568
|
if you want to fork the lane from a certain point in history, use "lane checkout" and create a new lane from it.
|
|
1568
1569
|
|
|
1569
1570
|
| **Arg** | **Description** |
|
|
@@ -1591,7 +1592,7 @@ when the components are not diverged in history, and the current lane is behind
|
|
|
1591
1592
|
simply update the components and the heads according to the merge candidate.
|
|
1592
1593
|
to opt-out, use "--no-snap", the components will be written as the merge candidate, and will be left as modified.
|
|
1593
1594
|
|
|
1594
|
-
in case a component
|
|
1595
|
+
in case a component on both ends doesn't share history (no snap is found in common), the merge will require "--resolve-unrelated" flag.
|
|
1595
1596
|
this flag keeps the history of one end and saves a reference to the other end. the decision of which end to keep is determined by the following:
|
|
1596
1597
|
|
|
1597
1598
|
1. if the component exists on main, then the history linked to main will be kept.
|
|
@@ -1625,7 +1626,7 @@ this flag keeps the history of one end and saves a reference to the other end. t
|
|
|
1625
1626
|
| `--ignore-config-changes` | | allow merging when components are modified due to config changes (such as dependencies) only and not files |
|
|
1626
1627
|
| `--verbose` | | display detailed information about components that were legitimately unmerged |
|
|
1627
1628
|
| `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components |
|
|
1628
|
-
| `--skip-fetch` | | use the local state of target-lane if
|
|
1629
|
+
| `--skip-fetch` | | use the local state of target-lane if exists locally, without updating it from the remote |
|
|
1629
1630
|
| `--include-deps` | | relevant for "pattern" and "--workspace". merge also dependencies of the specified components |
|
|
1630
1631
|
| `--resolve-unrelated [merge-strategy]` | | relevant when a component on a lane and the component on main have nothing in common. merge-strategy can be "ours" (default) or "theirs" |
|
|
1631
1632
|
| `--include-non-lane-comps` | | DEPRECATED (this is now the default). when merging main, include workspace components that are not on the lane (by default only lane components are merged) |
|
|
@@ -1651,8 +1652,8 @@ also, checkout the workspace components according to the restored lane state
|
|
|
1651
1652
|
**Usage**: `lane merge-move <new-lane-name>`
|
|
1652
1653
|
|
|
1653
1654
|
**Description**: EXPERIMENT. move the current merge state into a new lane. the current lane will be reset
|
|
1654
|
-
this command is useful when you got a messy merge state that
|
|
1655
|
-
to
|
|
1655
|
+
this command is useful when you got a messy merge state that on one hand you don't want
|
|
1656
|
+
to lose the changes, but on the other hand, you want to keep your lane without those changes.
|
|
1656
1657
|
this command does the following:
|
|
1657
1658
|
|
|
1658
1659
|
1. create a new lane with the current merge state. including all the filesystem changes. (in practice, it leaves the fs intact)
|
|
@@ -1840,7 +1841,7 @@ supports custom cloud domains, CI/machine authentication, and manual token refre
|
|
|
1840
1841
|
| `--port <port>` | `-p` | port number to open for localhost server (default 8085) |
|
|
1841
1842
|
| `--no-browser` | | do not open a browser for authentication |
|
|
1842
1843
|
| `--machine-name <name>` | | specify machine-name to pair with the token (useful for CI to avoid accidentally revoking the token) |
|
|
1843
|
-
| `--suppress-browser-launch` | |
|
|
1844
|
+
| `--suppress-browser-launch` | | DEPRECATED. use --no-browser instead |
|
|
1844
1845
|
|
|
1845
1846
|
---
|
|
1846
1847
|
|
|
@@ -1994,7 +1995,7 @@ installs dependencies and configures the workspace for immediate development.
|
|
|
1994
1995
|
| `--standalone` | | DEPRECATED. use --skip-git instead |
|
|
1995
1996
|
| `--skip-git` | `-s` | skip generation of Git repository in the new workspace |
|
|
1996
1997
|
| `--empty` | `-e` | skip template's default component creation (relevant for templates that add components by default) |
|
|
1997
|
-
| `--load-from <path-to-template>` | | local path to the workspace containing the template. Helpful during
|
|
1998
|
+
| `--load-from <path-to-template>` | | local path to the workspace containing the template. Helpful during the development of a workspace-template |
|
|
1998
1999
|
| `--current-dir` | `-c` | create the new workspace in current directory (default is to create a new directory, inside the current dir) |
|
|
1999
2000
|
| `--agent [type]` | | create an AI agent instructions file. options: claude, cursor, copilot (default: AGENTS.md) |
|
|
2000
2001
|
|
|
@@ -2175,7 +2176,7 @@ for local components: simply renames the existing component in place.
|
|
|
2175
2176
|
| `--preserve` | | avoid renaming files and variables/classes according to the new component name |
|
|
2176
2177
|
| `--ast` | | use ast to transform files instead of regex |
|
|
2177
2178
|
| `--delete` | | DEPRECATED. this is now the default |
|
|
2178
|
-
| `--deprecate` | | instead of deleting the original component,
|
|
2179
|
+
| `--deprecate` | | instead of deleting the original component, deprecate it |
|
|
2179
2180
|
| `--path <relative-path>` | `-p` | relative path in the workspace to place new component in. by default, the directory of the new component is from your workspace's "defaultScope" value |
|
|
2180
2181
|
|
|
2181
2182
|
---
|
|
@@ -2391,7 +2392,7 @@ essential for organizing components and managing component namespaces across tea
|
|
|
2391
2392
|
|
|
2392
2393
|
**Description**: Sets the scope for specified component/s. If no component is specified, sets the default scope of the workspace
|
|
2393
2394
|
default scopes for components are set in the bitmap file. the default scope for a workspace is set in the workspace.jsonc.
|
|
2394
|
-
a component is set with a scope (as
|
|
2395
|
+
a component is set with a scope (as opposed to default scope) only once it is versioned.
|
|
2395
2396
|
|
|
2396
2397
|
you can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name "org.scope/utils/**"`.
|
|
2397
2398
|
use comma to separate patterns and '!' to exclude. e.g. 'ui/\*\*, !ui/button'
|
|
@@ -2443,7 +2444,7 @@ as a result of this change
|
|
|
2443
2444
|
| -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------- |
|
|
2444
2445
|
| `--preserve` | | avoid renaming files and variables/classes according to the new scope name |
|
|
2445
2446
|
| `--refactor` | `-r` | update the import statements in all dependent components to the new package name (i.e. with the new scope name) |
|
|
2446
|
-
| `--deprecate` | | for exported components, instead of deleting the original components,
|
|
2447
|
+
| `--deprecate` | | for exported components, instead of deleting the original components, deprecate them |
|
|
2447
2448
|
| `--skip-dependency-installation` | `-x` | do not install dependencies after the rename |
|
|
2448
2449
|
|
|
2449
2450
|
### scope rename-owner
|
|
@@ -2613,7 +2614,7 @@ includes hot module reloading for development.
|
|
|
2613
2614
|
| `--port [port-number]` | `-p` | port of the UI server. |
|
|
2614
2615
|
| `--rebuild` | `-r` | rebuild the UI (useful e.g. when updating the workspace UI - can use the dev flag for HMR in this case) |
|
|
2615
2616
|
| `--skip-ui-build` | | skip building UI |
|
|
2616
|
-
| `--verbose` | `-v` | show verbose output for inspection and
|
|
2617
|
+
| `--verbose` | `-v` | show verbose output for inspection and print stack trace |
|
|
2617
2618
|
| `--no-browser` | `-n` | do not automatically open browser when ready |
|
|
2618
2619
|
| `--show-internal-urls` | | show urls for all internal dev servers |
|
|
2619
2620
|
| `--skip-compilation` | | skip the auto-compilation before starting the web-server |
|
|
@@ -2728,41 +2729,42 @@ use for official releases. for development versions, use 'bit snap' instead.
|
|
|
2728
2729
|
|
|
2729
2730
|
`bit tag [component-patterns...]`
|
|
2730
2731
|
|
|
2731
|
-
| **Arg** |
|
|
2732
|
-
| ----------------------- |
|
|
2733
|
-
| `component-patterns...` | component name, component id, component pattern, or relative directory path. 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 '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.. By default, all new and modified are tagged. |
|
|
2734
|
-
|
|
2735
|
-
| **Option**
|
|
2736
|
-
|
|
|
2737
|
-
| `--message <message>`
|
|
2738
|
-
| `--unmodified`
|
|
2739
|
-
| `--editor [editor]`
|
|
2740
|
-
| `--versions-file <path>`
|
|
2741
|
-
| `--ver <version>`
|
|
2742
|
-
| `--increment <level>`
|
|
2743
|
-
| `--prerelease-id <id>`
|
|
2744
|
-
| `--patch`
|
|
2745
|
-
| `--minor`
|
|
2746
|
-
| `--major`
|
|
2747
|
-
| `--pre-release [identifier]`
|
|
2748
|
-
| `--
|
|
2749
|
-
| `--
|
|
2750
|
-
| `--
|
|
2751
|
-
| `--skip-
|
|
2752
|
-
| `--skip-
|
|
2753
|
-
| `--
|
|
2754
|
-
| `--
|
|
2755
|
-
| `--
|
|
2756
|
-
| `--
|
|
2757
|
-
| `--
|
|
2758
|
-
| `--
|
|
2759
|
-
| `--
|
|
2760
|
-
| `--
|
|
2761
|
-
| `--ignore-
|
|
2762
|
-
| `--
|
|
2763
|
-
| `--
|
|
2764
|
-
| `--
|
|
2765
|
-
| `--
|
|
2732
|
+
| **Arg** | **Description** |
|
|
2733
|
+
| ----------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
2734
|
+
| `component-patterns...` | component name, component id, component pattern, or relative directory path. 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 '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.. By default, all new and modified components are tagged. |
|
|
2735
|
+
|
|
2736
|
+
| **Option** | **Option alias** | **Description** |
|
|
2737
|
+
| ------------------------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2738
|
+
| `--message <message>` | `-m` | a log message describing latest changes |
|
|
2739
|
+
| `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are tagged) |
|
|
2740
|
+
| `--editor [editor]` | | open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim). |
|
|
2741
|
+
| `--versions-file <path>` | | path to a file containing component versions. format: "component-id: version" |
|
|
2742
|
+
| `--ver <version>` | `-v` | tag with the given version |
|
|
2743
|
+
| `--increment <level>` | `-l` | options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch |
|
|
2744
|
+
| `--prerelease-id <id>` | | prerelease identifier (e.g. "dev" to get "1.0.0-dev.1") |
|
|
2745
|
+
| `--patch` | `-p` | syntactic sugar for "--increment patch" |
|
|
2746
|
+
| `--minor` | | syntactic sugar for "--increment minor" |
|
|
2747
|
+
| `--major` | | syntactic sugar for "--increment major" |
|
|
2748
|
+
| `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` |
|
|
2749
|
+
| `--auto-tag-increment <level>` | | the increment level to use for auto-tagged dependents. options are: [major, premajor, minor, preminor, patch, prepatch, prerelease]. by default, dependents are bumped by a patch, unless --increment is one of [prepatch, prerelease, preminor, premajor], which they follow. note that dependents are auto-tagged transitively, so the entire dependents graph is bumped by this level |
|
|
2750
|
+
| `--snapped` | | tag only components whose head is a snap (not a tag) |
|
|
2751
|
+
| `--unmerged` | | complete a merge process by tagging the unmerged components |
|
|
2752
|
+
| `--skip-tests` | | skip running component tests during tag process |
|
|
2753
|
+
| `--skip-tasks <string>` | | skip the given tasks. for multiple tasks, separate by a comma and wrap with quotes. specify the task-name (e.g. "TypescriptCompiler") or the task-aspect-id (e.g. teambit.compilation/compiler) |
|
|
2754
|
+
| `--skip-auto-tag` | | skip auto tagging dependents |
|
|
2755
|
+
| `--soft` | | do not persist. only keep note of the changes to be made |
|
|
2756
|
+
| `--persist [skip-build]` | | persist the changes generated by --soft tag. by default, run the build pipeline, unless "skip-build" is provided |
|
|
2757
|
+
| `--disable-tag-pipeline` | | skip the tag pipeline to avoid publishing the components |
|
|
2758
|
+
| `--ignore-build-errors` | | proceed to tag pipeline even when build pipeline fails |
|
|
2759
|
+
| `--rebuild-deps-graph` | | do not reuse the saved dependencies graph, instead build it from scratch |
|
|
2760
|
+
| `--no-lock-deps` | | do not save the dependencies graph in the tag |
|
|
2761
|
+
| `--increment-by <number>` | | (default to 1) increment semver flag (patch/minor/major) by. e.g. incrementing patch by 2: 0.0.1 -> 0.0.3. |
|
|
2762
|
+
| `--ignore-issues <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, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory, LoadFailures] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
|
|
2763
|
+
| `--ignore-newest-version` | `-I` | allow tagging even when the component has newer versions e.g. for hotfixes. |
|
|
2764
|
+
| `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) |
|
|
2765
|
+
| `--build` | `-b` | locally run the build pipeline (i.e. not via rippleCI) and complete the tag |
|
|
2766
|
+
| `--loose` | | allow tag --build to succeed even if tasks like tests or lint fail |
|
|
2767
|
+
| `--detach-head` | | UNSUPPORTED YET. in case a component is checked out to an older version, tag it without changing the head |
|
|
2766
2768
|
|
|
2767
2769
|
---
|
|
2768
2770
|
|