@teambit/harmony.content.cli-reference 2.0.1213 → 2.0.1215
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 +3 -3
- package/cli-reference.mdx +13 -13
- package/dist/cli-reference.docs.mdx +1 -1
- package/dist/cli-reference.json +3 -3
- package/dist/cli-reference.mdx.js +1 -1
- package/dist/cli-reference.mdx.js.map +1 -1
- package/dist/{preview-1787260228106.js → preview-1787325829408.js} +2 -2
- package/package.json +2 -2
package/cli-reference.docs.mdx
CHANGED
package/cli-reference.json
CHANGED
|
@@ -2817,7 +2817,7 @@
|
|
|
2817
2817
|
[
|
|
2818
2818
|
"",
|
|
2819
2819
|
"hard",
|
|
2820
|
-
"NOT-RECOMMENDED. delete a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents."
|
|
2820
|
+
"NOT-RECOMMENDED. delete a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents. requires interactive confirmation by a human (--silent does not skip it)"
|
|
2821
2821
|
],
|
|
2822
2822
|
[
|
|
2823
2823
|
"f",
|
|
@@ -5161,13 +5161,13 @@
|
|
|
5161
5161
|
]
|
|
5162
5162
|
],
|
|
5163
5163
|
"description": "Reconciles Bit lanes and the main scope with git branches and pull requests.",
|
|
5164
|
-
"extendedDescription": "Stateless reconciler: compares each mapped lane's remote head against the state the branch itself records, and converges — importing lane changes onto the branch, exporting dev commits to the lane, or opening/closing PRs. That state comes from bit's own data: the .bitmap committed on the branch, which records the lane the branch mirrors and the exact version of every component on it. The \"chore(bit-sync)\" subject, \"Bit-Lane-Head\" trailer and \"[bit-sync]\" marker on sync commits are annotations for humans and triggers; the only decision that consults one is branch deletion, which additionally requires the marker to prove the reconciler wrote the branch tip. The main scope is reconciled by checking the workspace out to its latest exported versions and proposing the result as a sync PR. Triggers (webhook, push, cron) only decide when it runs, never what it does. Safe to re-run at any time; converged state is a no-op. A lane
|
|
5164
|
+
"extendedDescription": "Stateless reconciler: compares each mapped lane's remote head against the state the branch itself records, and converges — importing lane changes onto the branch, exporting dev commits to the lane, or opening/closing PRs. That state comes from bit's own data: the .bitmap committed on the branch, which records the lane the branch mirrors and the exact version of every component on it. The \"chore(bit-sync)\" subject, \"Bit-Lane-Head\" trailer and \"[bit-sync]\" marker on sync commits are annotations for humans and triggers; the only decision that consults one is branch deletion, which additionally requires the marker to prove the reconciler wrote the branch tip. The main scope is reconciled by checking the workspace out to its latest exported versions and proposing the result as a sync PR. Triggers (webhook, push, cron) only decide when it runs, never what it does. Safe to re-run at any time; converged state is a no-op. A lane carrying components from other scopes (a cross-scope lane) is reconciled over its defaultScope slice only: foreign components are never written into this repository — the branch consumes them as package dependencies at their lane versions, and only their own scopes' repositories can mirror their sources. A lane with no defaultScope components has nothing to mirror here: enumerated runs skip it and stay green, an explicitly named one is refused, and a mirrored lane whose defaultScope components all left it is halted for a human. Configure mapping under `\"teambit.git/ci\": { \"sync\": { ... } }` in workspace.jsonc.",
|
|
5165
5165
|
"group": "collaborate",
|
|
5166
5166
|
"private": false,
|
|
5167
5167
|
"arguments": [
|
|
5168
5168
|
{
|
|
5169
5169
|
"name": "lane",
|
|
5170
|
-
"description": "the lane to reconcile: either a lane name (hosted on the workspace's defaultScope) or a scope-qualified lane id, \"other-org.other-scope/my-lane\", for a lane hosted on another scope.
|
|
5170
|
+
"description": "the lane to reconcile: either a lane name (hosted on the workspace's defaultScope) or a scope-qualified lane id, \"other-org.other-scope/my-lane\", for a lane hosted on another scope. Only the lane's defaultScope components are mirrored; components from other scopes stay on the lane as package dependencies"
|
|
5171
5171
|
}
|
|
5172
5172
|
]
|
|
5173
5173
|
}
|
package/cli-reference.mdx
CHANGED
|
@@ -465,11 +465,11 @@ By default, bumps patch versions when merging to main. If specific configuration
|
|
|
465
465
|
**Usage**: `ci sync [lane]`
|
|
466
466
|
|
|
467
467
|
**Description**: Reconciles Bit lanes and the main scope with git branches and pull requests.
|
|
468
|
-
Stateless reconciler: compares each mapped lane's remote head against the state the branch itself records, and converges — importing lane changes onto the branch, exporting dev commits to the lane, or opening/closing PRs. That state comes from bit's own data: the .bitmap committed on the branch, which records the lane the branch mirrors and the exact version of every component on it. The "chore(bit-sync)" subject, "Bit-Lane-Head" trailer and "[bit-sync]" marker on sync commits are annotations for humans and triggers; the only decision that consults one is branch deletion, which additionally requires the marker to prove the reconciler wrote the branch tip. The main scope is reconciled by checking the workspace out to its latest exported versions and proposing the result as a sync PR. Triggers (webhook, push, cron) only decide when it runs, never what it does. Safe to re-run at any time; converged state is a no-op. A lane
|
|
468
|
+
Stateless reconciler: compares each mapped lane's remote head against the state the branch itself records, and converges — importing lane changes onto the branch, exporting dev commits to the lane, or opening/closing PRs. That state comes from bit's own data: the .bitmap committed on the branch, which records the lane the branch mirrors and the exact version of every component on it. The "chore(bit-sync)" subject, "Bit-Lane-Head" trailer and "[bit-sync]" marker on sync commits are annotations for humans and triggers; the only decision that consults one is branch deletion, which additionally requires the marker to prove the reconciler wrote the branch tip. The main scope is reconciled by checking the workspace out to its latest exported versions and proposing the result as a sync PR. Triggers (webhook, push, cron) only decide when it runs, never what it does. Safe to re-run at any time; converged state is a no-op. A lane carrying components from other scopes (a cross-scope lane) is reconciled over its defaultScope slice only: foreign components are never written into this repository — the branch consumes them as package dependencies at their lane versions, and only their own scopes' repositories can mirror their sources. A lane with no defaultScope components has nothing to mirror here: enumerated runs skip it and stay green, an explicitly named one is refused, and a mirrored lane whose defaultScope components all left it is halted for a human. Configure mapping under `"teambit.git/ci": { "sync": { ... } }` in workspace.jsonc.
|
|
469
469
|
|
|
470
|
-
| **Arg** |
|
|
471
|
-
| ------- |
|
|
472
|
-
| `lane` | the lane to reconcile: either a lane name (hosted on the workspace's defaultScope) or a scope-qualified lane id, "other-org.other-scope/my-lane", for a lane hosted on another scope.
|
|
470
|
+
| **Arg** | **Description** |
|
|
471
|
+
| ------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
472
|
+
| `lane` | the lane to reconcile: either a lane name (hosted on the workspace's defaultScope) or a scope-qualified lane id, "other-org.other-scope/my-lane", for a lane hosted on another scope. Only the lane's defaultScope components are mirrored; components from other scopes stay on the lane as package dependencies |
|
|
473
473
|
|
|
474
474
|
| **Option** | **Option alias** | **Description** |
|
|
475
475
|
| ------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
@@ -614,15 +614,15 @@ to remove components from your local workspace only, use "bit remove" instead.
|
|
|
614
614
|
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
615
615
|
| `component-pattern` | 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. |
|
|
616
616
|
|
|
617
|
-
| **Option** | **Option alias** | **Description**
|
|
618
|
-
| ------------------ | :--------------: |
|
|
619
|
-
| `--lane` | | when on a lane, delete the component from this lane only. this removal will not affect main when the lane is merged
|
|
620
|
-
| `--update-main` | | delete component/s on the main lane after merging this lane into main
|
|
621
|
-
| `--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
|
|
622
|
-
| `--silent` | `-s` | skip confirmation
|
|
623
|
-
| `--hard` | | NOT-RECOMMENDED. delete a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents.
|
|
624
|
-
| `--force` | `-f` | relevant for --hard. allow the deletion even if used as a dependency. WARNING: components that depend on this component will be corrupted
|
|
625
|
-
| `--snaps <string>` | | comma-separated list of snap hashes to mark as deleted (e.g. --snaps "hash1,hash2,hash3")
|
|
617
|
+
| **Option** | **Option alias** | **Description** |
|
|
618
|
+
| ------------------ | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
619
|
+
| `--lane` | | when on a lane, delete the component from this lane only. this removal will not affect main when the lane is merged |
|
|
620
|
+
| `--update-main` | | delete component/s on the main lane after merging this lane into main |
|
|
621
|
+
| `--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 |
|
|
622
|
+
| `--silent` | `-s` | skip confirmation |
|
|
623
|
+
| `--hard` | | NOT-RECOMMENDED. delete a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents. requires interactive confirmation by a human (--silent does not skip it) |
|
|
624
|
+
| `--force` | `-f` | relevant for --hard. allow the deletion even if used as a dependency. WARNING: components that depend on this component will be corrupted |
|
|
625
|
+
| `--snaps <string>` | | comma-separated list of snap hashes to mark as deleted (e.g. --snaps "hash1,hash2,hash3") |
|
|
626
626
|
|
|
627
627
|
---
|
|
628
628
|
|
package/dist/cli-reference.json
CHANGED
|
@@ -2817,7 +2817,7 @@
|
|
|
2817
2817
|
[
|
|
2818
2818
|
"",
|
|
2819
2819
|
"hard",
|
|
2820
|
-
"NOT-RECOMMENDED. delete a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents."
|
|
2820
|
+
"NOT-RECOMMENDED. delete a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents. requires interactive confirmation by a human (--silent does not skip it)"
|
|
2821
2821
|
],
|
|
2822
2822
|
[
|
|
2823
2823
|
"f",
|
|
@@ -5161,13 +5161,13 @@
|
|
|
5161
5161
|
]
|
|
5162
5162
|
],
|
|
5163
5163
|
"description": "Reconciles Bit lanes and the main scope with git branches and pull requests.",
|
|
5164
|
-
"extendedDescription": "Stateless reconciler: compares each mapped lane's remote head against the state the branch itself records, and converges — importing lane changes onto the branch, exporting dev commits to the lane, or opening/closing PRs. That state comes from bit's own data: the .bitmap committed on the branch, which records the lane the branch mirrors and the exact version of every component on it. The \"chore(bit-sync)\" subject, \"Bit-Lane-Head\" trailer and \"[bit-sync]\" marker on sync commits are annotations for humans and triggers; the only decision that consults one is branch deletion, which additionally requires the marker to prove the reconciler wrote the branch tip. The main scope is reconciled by checking the workspace out to its latest exported versions and proposing the result as a sync PR. Triggers (webhook, push, cron) only decide when it runs, never what it does. Safe to re-run at any time; converged state is a no-op. A lane
|
|
5164
|
+
"extendedDescription": "Stateless reconciler: compares each mapped lane's remote head against the state the branch itself records, and converges — importing lane changes onto the branch, exporting dev commits to the lane, or opening/closing PRs. That state comes from bit's own data: the .bitmap committed on the branch, which records the lane the branch mirrors and the exact version of every component on it. The \"chore(bit-sync)\" subject, \"Bit-Lane-Head\" trailer and \"[bit-sync]\" marker on sync commits are annotations for humans and triggers; the only decision that consults one is branch deletion, which additionally requires the marker to prove the reconciler wrote the branch tip. The main scope is reconciled by checking the workspace out to its latest exported versions and proposing the result as a sync PR. Triggers (webhook, push, cron) only decide when it runs, never what it does. Safe to re-run at any time; converged state is a no-op. A lane carrying components from other scopes (a cross-scope lane) is reconciled over its defaultScope slice only: foreign components are never written into this repository — the branch consumes them as package dependencies at their lane versions, and only their own scopes' repositories can mirror their sources. A lane with no defaultScope components has nothing to mirror here: enumerated runs skip it and stay green, an explicitly named one is refused, and a mirrored lane whose defaultScope components all left it is halted for a human. Configure mapping under `\"teambit.git/ci\": { \"sync\": { ... } }` in workspace.jsonc.",
|
|
5165
5165
|
"group": "collaborate",
|
|
5166
5166
|
"private": false,
|
|
5167
5167
|
"arguments": [
|
|
5168
5168
|
{
|
|
5169
5169
|
"name": "lane",
|
|
5170
|
-
"description": "the lane to reconcile: either a lane name (hosted on the workspace's defaultScope) or a scope-qualified lane id, \"other-org.other-scope/my-lane\", for a lane hosted on another scope.
|
|
5170
|
+
"description": "the lane to reconcile: either a lane name (hosted on the workspace's defaultScope) or a scope-qualified lane id, \"other-org.other-scope/my-lane\", for a lane hosted on another scope. Only the lane's defaultScope components are mirrored; components from other scopes stay on the lane as package dependencies"
|
|
5171
5171
|
}
|
|
5172
5172
|
]
|
|
5173
5173
|
}
|