@teambit/harmony.content.cli-reference 2.0.505 → 2.0.507

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.
@@ -1,5 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.9.18'
2
+ description: 'Bit command synopses. Bit version: 1.9.20'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
-
@@ -3136,7 +3136,7 @@
3136
3136
  [
3137
3137
  "I",
3138
3138
  "ignore-newest-version",
3139
- "allow tagging even when the component has newer versions e.g. for hotfixes (default = false)"
3139
+ "allow tagging even when the component has newer versions e.g. for hotfixes."
3140
3140
  ],
3141
3141
  [
3142
3142
  "",
@@ -3147,6 +3147,11 @@
3147
3147
  "b",
3148
3148
  "build",
3149
3149
  "locally run the build pipeline (i.e. not via rippleCI) and complete the tag"
3150
+ ],
3151
+ [
3152
+ "",
3153
+ "detach-head",
3154
+ "UNSUPPORTED YET. in case a component is checked out to an older version, tag it without changing the head"
3150
3155
  ]
3151
3156
  ],
3152
3157
  "description": "create an immutable and exportable component snapshot, tagged with a release version.",
@@ -3235,6 +3240,11 @@
3235
3240
  "",
3236
3241
  "fail-fast",
3237
3242
  "stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed)"
3243
+ ],
3244
+ [
3245
+ "",
3246
+ "detach-head",
3247
+ "UNSUPPORTED YET. in case a component is checked out to an older version, snap it without changing the head"
3238
3248
  ]
3239
3249
  ],
3240
3250
  "description": "create an immutable and exportable component snapshot (non-release version)",
@@ -3312,6 +3322,11 @@
3312
3322
  "ignore-last-pkg-json",
3313
3323
  "ignore the package.json created by the last snap"
3314
3324
  ],
3325
+ [
3326
+ "",
3327
+ "override-head",
3328
+ "opposite of detach-head. in case a component is checked out to an older version, change head to the newly created version"
3329
+ ],
3315
3330
  [
3316
3331
  "m",
3317
3332
  "message <message>",
@@ -3395,7 +3410,7 @@
3395
3410
  [
3396
3411
  "I",
3397
3412
  "ignore-newest-version",
3398
- "allow tagging even when the component has newer versions e.g. for hotfixes (default = false)"
3413
+ "allow tagging even when the component has newer versions e.g. for hotfixes."
3399
3414
  ],
3400
3415
  [
3401
3416
  "",
@@ -3406,6 +3421,11 @@
3406
3421
  "b",
3407
3422
  "build",
3408
3423
  "locally run the build pipeline (i.e. not via rippleCI) and complete the tag"
3424
+ ],
3425
+ [
3426
+ "",
3427
+ "detach-head",
3428
+ "UNSUPPORTED YET. in case a component is checked out to an older version, tag it without changing the head"
3409
3429
  ]
3410
3430
  ],
3411
3431
  "description": "tag components from a bare-scope by using build artifacts from previous snap and running the deploy-pipeline only",
@@ -4146,6 +4166,11 @@
4146
4166
  "",
4147
4167
  "exclude-non-lane-comps",
4148
4168
  "when merging main into a lane, exclude workspace components that are not on the lane (by default all workspace components are merged)"
4169
+ ],
4170
+ [
4171
+ "",
4172
+ "detach-head",
4173
+ "UNSUPPORTED YET. for each component, find the divergent point from main and merge to that point. do not change the head"
4149
4174
  ]
4150
4175
  ],
4151
4176
  "description": "merge a local or a remote lane to the current lane",
@@ -5056,7 +5081,7 @@
5056
5081
  ]
5057
5082
  ],
5058
5083
  "description": "clears Bit's cache from current working machine",
5059
- "extendedDescription": "The following gets removed by this command:\n1) V8 compiled code (generated the first time Bit is loaded by v8-compile-cache package)\n2) components cache on the filesystem (mainly the dependencies graph and docs)\n3) scope's index file, which maps the component-id:object-hash",
5084
+ "extendedDescription": "The following gets removed by this command:\n1) components cache on the filesystem (mainly the dependencies graph and docs)\n2) scope's index file, which maps the component-id:object-hash",
5060
5085
  "group": "general",
5061
5086
  "private": false,
5062
5087
  "skipWorkspace": true
package/cli-reference.mdx CHANGED
@@ -334,9 +334,8 @@ when on a lane, "checkout head" only checks out components on this lane. to upda
334
334
  **Description**: clears Bit's cache from current working machine
335
335
  The following gets removed by this command:
336
336
 
337
- 1. V8 compiled code (generated the first time Bit is loaded by v8-compile-cache package)
338
- 2. components cache on the filesystem (mainly the dependencies graph and docs)
339
- 3. scope's index file, which maps the component-id:object-hash
337
+ 1. components cache on the filesystem (mainly the dependencies graph and docs)
338
+ 2. scope's index file, which maps the component-id:object-hash
340
339
 
341
340
  `bit clear-cache`
342
341
 
@@ -1336,6 +1335,7 @@ this flag keeps the history of one end and saves a reference to the other end. t
1336
1335
  | `--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" |
1337
1336
  | `--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) |
1338
1337
  | `--exclude-non-lane-comps` | | when merging main into a lane, exclude workspace components that are not on the lane (by default all workspace components are merged) |
1338
+ | `--detach-head` | | UNSUPPORTED YET. for each component, find the divergent point from main and merge to that point. do not change the head |
1339
1339
 
1340
1340
  ### lane merge-abort
1341
1341
 
@@ -2005,6 +2005,7 @@ as a result of this change
2005
2005
  | `--rebuild-deps-graph` | | do not reuse the saved dependencies graph, instead build it from scratch |
2006
2006
  | `--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] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
2007
2007
  | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) |
2008
+ | `--detach-head` | | UNSUPPORTED YET. in case a component is checked out to an older version, snap it without changing the head |
2008
2009
 
2009
2010
  ---
2010
2011
 
@@ -2153,9 +2154,10 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
2153
2154
  | `--rebuild-deps-graph` | | do not reuse the saved dependencies graph, instead build it from scratch |
2154
2155
  | `--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. |
2155
2156
  | `--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] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
2156
- | `--ignore-newest-version` | `-I` | allow tagging even when the component has newer versions e.g. for hotfixes (default = false) |
2157
+ | `--ignore-newest-version` | `-I` | allow tagging even when the component has newer versions e.g. for hotfixes. |
2157
2158
  | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) |
2158
2159
  | `--build` | `-b` | locally run the build pipeline (i.e. not via rippleCI) and complete the tag |
2160
+ | `--detach-head` | | UNSUPPORTED YET. in case a component is checked out to an older version, tag it without changing the head |
2159
2161
 
2160
2162
  ---
2161
2163
 
@@ -1,5 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.9.18'
2
+ description: 'Bit command synopses. Bit version: 1.9.20'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
-
@@ -3136,7 +3136,7 @@
3136
3136
  [
3137
3137
  "I",
3138
3138
  "ignore-newest-version",
3139
- "allow tagging even when the component has newer versions e.g. for hotfixes (default = false)"
3139
+ "allow tagging even when the component has newer versions e.g. for hotfixes."
3140
3140
  ],
3141
3141
  [
3142
3142
  "",
@@ -3147,6 +3147,11 @@
3147
3147
  "b",
3148
3148
  "build",
3149
3149
  "locally run the build pipeline (i.e. not via rippleCI) and complete the tag"
3150
+ ],
3151
+ [
3152
+ "",
3153
+ "detach-head",
3154
+ "UNSUPPORTED YET. in case a component is checked out to an older version, tag it without changing the head"
3150
3155
  ]
3151
3156
  ],
3152
3157
  "description": "create an immutable and exportable component snapshot, tagged with a release version.",
@@ -3235,6 +3240,11 @@
3235
3240
  "",
3236
3241
  "fail-fast",
3237
3242
  "stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed)"
3243
+ ],
3244
+ [
3245
+ "",
3246
+ "detach-head",
3247
+ "UNSUPPORTED YET. in case a component is checked out to an older version, snap it without changing the head"
3238
3248
  ]
3239
3249
  ],
3240
3250
  "description": "create an immutable and exportable component snapshot (non-release version)",
@@ -3312,6 +3322,11 @@
3312
3322
  "ignore-last-pkg-json",
3313
3323
  "ignore the package.json created by the last snap"
3314
3324
  ],
3325
+ [
3326
+ "",
3327
+ "override-head",
3328
+ "opposite of detach-head. in case a component is checked out to an older version, change head to the newly created version"
3329
+ ],
3315
3330
  [
3316
3331
  "m",
3317
3332
  "message <message>",
@@ -3395,7 +3410,7 @@
3395
3410
  [
3396
3411
  "I",
3397
3412
  "ignore-newest-version",
3398
- "allow tagging even when the component has newer versions e.g. for hotfixes (default = false)"
3413
+ "allow tagging even when the component has newer versions e.g. for hotfixes."
3399
3414
  ],
3400
3415
  [
3401
3416
  "",
@@ -3406,6 +3421,11 @@
3406
3421
  "b",
3407
3422
  "build",
3408
3423
  "locally run the build pipeline (i.e. not via rippleCI) and complete the tag"
3424
+ ],
3425
+ [
3426
+ "",
3427
+ "detach-head",
3428
+ "UNSUPPORTED YET. in case a component is checked out to an older version, tag it without changing the head"
3409
3429
  ]
3410
3430
  ],
3411
3431
  "description": "tag components from a bare-scope by using build artifacts from previous snap and running the deploy-pipeline only",
@@ -4146,6 +4166,11 @@
4146
4166
  "",
4147
4167
  "exclude-non-lane-comps",
4148
4168
  "when merging main into a lane, exclude workspace components that are not on the lane (by default all workspace components are merged)"
4169
+ ],
4170
+ [
4171
+ "",
4172
+ "detach-head",
4173
+ "UNSUPPORTED YET. for each component, find the divergent point from main and merge to that point. do not change the head"
4149
4174
  ]
4150
4175
  ],
4151
4176
  "description": "merge a local or a remote lane to the current lane",
@@ -5056,7 +5081,7 @@
5056
5081
  ]
5057
5082
  ],
5058
5083
  "description": "clears Bit's cache from current working machine",
5059
- "extendedDescription": "The following gets removed by this command:\n1) V8 compiled code (generated the first time Bit is loaded by v8-compile-cache package)\n2) components cache on the filesystem (mainly the dependencies graph and docs)\n3) scope's index file, which maps the component-id:object-hash",
5084
+ "extendedDescription": "The following gets removed by this command:\n1) components cache on the filesystem (mainly the dependencies graph and docs)\n2) scope's index file, which maps the component-id:object-hash",
5060
5085
  "group": "general",
5061
5086
  "private": false,
5062
5087
  "skipWorkspace": true
@@ -1761,8 +1761,6 @@ function MDXContent(_ref) {
1761
1761
  parentName: "p"
1762
1762
  }), "\n", "The following gets removed by this command:"), (0, _react2.mdx)("ol", null, (0, _react2.mdx)("li", {
1763
1763
  parentName: "ol"
1764
- }, "V8 compiled code (generated the first time Bit is loaded by v8-compile-cache package)"), (0, _react2.mdx)("li", {
1765
- parentName: "ol"
1766
1764
  }, "components cache on the filesystem (mainly the dependencies graph and docs)"), (0, _react2.mdx)("li", {
1767
1765
  parentName: "ol"
1768
1766
  }, "scope's index file, which maps the component-id:object-hash")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
@@ -7017,7 +7015,20 @@ function MDXContent(_ref) {
7017
7015
  }), (0, _react2.mdx)("td", {
7018
7016
  parentName: "tr",
7019
7017
  "align": null
7020
- }, "when merging main into a lane, exclude workspace components that are not on the lane (by default all workspace components are merged)")))), (0, _react2.mdx)("h3", null, "lane merge-abort"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
7018
+ }, "when merging main into a lane, exclude workspace components that are not on the lane (by default all workspace components are merged)")), (0, _react2.mdx)("tr", {
7019
+ parentName: "tbody"
7020
+ }, (0, _react2.mdx)("td", {
7021
+ parentName: "tr",
7022
+ "align": null
7023
+ }, (0, _react2.mdx)("inlineCode", {
7024
+ parentName: "td"
7025
+ }, "--detach-head")), (0, _react2.mdx)("td", {
7026
+ parentName: "tr",
7027
+ "align": "center"
7028
+ }), (0, _react2.mdx)("td", {
7029
+ parentName: "tr",
7030
+ "align": null
7031
+ }, "UNSUPPORTED YET. for each component, find the divergent point from main and merge to that point. do not change the head")))), (0, _react2.mdx)("h3", null, "lane merge-abort"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
7021
7032
  parentName: "p"
7022
7033
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
7023
7034
  parentName: "p"
@@ -10462,7 +10473,20 @@ function MDXContent(_ref) {
10462
10473
  }), (0, _react2.mdx)("td", {
10463
10474
  parentName: "tr",
10464
10475
  "align": null
10465
- }, "stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed)")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "start"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
10476
+ }, "stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed)")), (0, _react2.mdx)("tr", {
10477
+ parentName: "tbody"
10478
+ }, (0, _react2.mdx)("td", {
10479
+ parentName: "tr",
10480
+ "align": null
10481
+ }, (0, _react2.mdx)("inlineCode", {
10482
+ parentName: "td"
10483
+ }, "--detach-head")), (0, _react2.mdx)("td", {
10484
+ parentName: "tr",
10485
+ "align": "center"
10486
+ }), (0, _react2.mdx)("td", {
10487
+ parentName: "tr",
10488
+ "align": null
10489
+ }, "UNSUPPORTED YET. in case a component is checked out to an older version, snap it without changing the head")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "start"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
10466
10490
  parentName: "p"
10467
10491
  }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
10468
10492
  parentName: "p"
@@ -11390,7 +11414,7 @@ function MDXContent(_ref) {
11390
11414
  }, "-I")), (0, _react2.mdx)("td", {
11391
11415
  parentName: "tr",
11392
11416
  "align": null
11393
- }, "allow tagging even when the component has newer versions e.g. for hotfixes (default = false)")), (0, _react2.mdx)("tr", {
11417
+ }, "allow tagging even when the component has newer versions e.g. for hotfixes.")), (0, _react2.mdx)("tr", {
11394
11418
  parentName: "tbody"
11395
11419
  }, (0, _react2.mdx)("td", {
11396
11420
  parentName: "tr",
@@ -11418,7 +11442,20 @@ function MDXContent(_ref) {
11418
11442
  }, "-b")), (0, _react2.mdx)("td", {
11419
11443
  parentName: "tr",
11420
11444
  "align": null
11421
- }, "locally run the build pipeline (i.e. not via rippleCI) and complete the tag")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "templates"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
11445
+ }, "locally run the build pipeline (i.e. not via rippleCI) and complete the tag")), (0, _react2.mdx)("tr", {
11446
+ parentName: "tbody"
11447
+ }, (0, _react2.mdx)("td", {
11448
+ parentName: "tr",
11449
+ "align": null
11450
+ }, (0, _react2.mdx)("inlineCode", {
11451
+ parentName: "td"
11452
+ }, "--detach-head")), (0, _react2.mdx)("td", {
11453
+ parentName: "tr",
11454
+ "align": "center"
11455
+ }), (0, _react2.mdx)("td", {
11456
+ parentName: "tr",
11457
+ "align": null
11458
+ }, "UNSUPPORTED YET. in case a component is checked out to an older version, tag it without changing the head")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "templates"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
11422
11459
  parentName: "p"
11423
11460
  }, "Description"), ": list available templates for \"bit create\" and \"bit new\"", (0, _react2.mdx)("br", {
11424
11461
  parentName: "p"