@teambit/harmony.content.cli-reference 2.0.1171 → 2.0.1173
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 -0
- package/cli-reference.mdx +19 -0
- package/dist/cli-reference.docs.mdx +1 -1
- package/dist/cli-reference.json +41 -0
- package/dist/cli-reference.mdx.js +1 -1
- package/dist/cli-reference.mdx.js.map +1 -1
- package/dist/{preview-1785846648967.js → preview-1785864931304.js} +2 -2
- package/package.json +2 -2
package/cli-reference.docs.mdx
CHANGED
package/cli-reference.json
CHANGED
|
@@ -5129,6 +5129,47 @@
|
|
|
5129
5129
|
"extendedDescription": "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.",
|
|
5130
5130
|
"group": "collaborate",
|
|
5131
5131
|
"private": false
|
|
5132
|
+
},
|
|
5133
|
+
{
|
|
5134
|
+
"name": "sync [lane]",
|
|
5135
|
+
"alias": "",
|
|
5136
|
+
"options": [
|
|
5137
|
+
[
|
|
5138
|
+
"",
|
|
5139
|
+
"branch <branch>",
|
|
5140
|
+
"Resolve the lane from this git branch name using the sync mapping config (cannot be combined with --all)"
|
|
5141
|
+
],
|
|
5142
|
+
[
|
|
5143
|
+
"",
|
|
5144
|
+
"all",
|
|
5145
|
+
"Reconcile every mapped lane plus the main scope (the default when no target is given; cannot be combined with a lane argument, --branch or --main)"
|
|
5146
|
+
],
|
|
5147
|
+
[
|
|
5148
|
+
"",
|
|
5149
|
+
"main",
|
|
5150
|
+
"Reconcile only the main scope against the default branch, opening a sync PR on drift (conflicts resolve in favour of the scope)"
|
|
5151
|
+
],
|
|
5152
|
+
[
|
|
5153
|
+
"",
|
|
5154
|
+
"dry-run",
|
|
5155
|
+
"Print the planned action per target. Nothing is pushed and no pull request is created or modified; the working tree is still written and then restored, so a dirty tree is refused rather than discarded"
|
|
5156
|
+
],
|
|
5157
|
+
[
|
|
5158
|
+
"",
|
|
5159
|
+
"init",
|
|
5160
|
+
"One-command onboarding: scaffold .github/workflows/bit-sync.yml + bit-release.yml (with this repository's actual default branch substituted), add the `\"teambit.git/ci\": { \"sync\": {} }` config block to workspace.jsonc if absent, and print the remaining manual-steps checklist (secrets + bit.cloud webhook). Writes nothing else and never overwrites an existing workflow file. Cannot be combined with a lane argument or any other flag."
|
|
5161
|
+
]
|
|
5162
|
+
],
|
|
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 whose components are not all in this workspace's defaultScope is a cross-scope lane: no branch is created for it (it would leak another repository's components into this one) — enumerated runs skip it and stay green, an explicitly named one is refused, and a lane that became cross-scope after its branch existed is halted for a human. Configure mapping under `\"teambit.git/ci\": { \"sync\": { ... } }` in workspace.jsonc.",
|
|
5165
|
+
"group": "collaborate",
|
|
5166
|
+
"private": false,
|
|
5167
|
+
"arguments": [
|
|
5168
|
+
{
|
|
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. Its components must still all live in this workspace's defaultScope"
|
|
5171
|
+
}
|
|
5172
|
+
]
|
|
5132
5173
|
}
|
|
5133
5174
|
]
|
|
5134
5175
|
},
|
package/cli-reference.mdx
CHANGED
|
@@ -460,6 +460,25 @@ By default, bumps patch versions when merging to main. If specific configuration
|
|
|
460
460
|
| `--skip-push` | | skip pushing the changes to the remote repository (useful when CI handles the push separately) |
|
|
461
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`. |
|
|
462
462
|
|
|
463
|
+
### ci sync
|
|
464
|
+
|
|
465
|
+
**Usage**: `ci sync [lane]`
|
|
466
|
+
|
|
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 whose components are not all in this workspace's defaultScope is a cross-scope lane: no branch is created for it (it would leak another repository's components into this one) — enumerated runs skip it and stay green, an explicitly named one is refused, and a lane that became cross-scope after its branch existed is halted for a human. Configure mapping under `"teambit.git/ci": { "sync": { ... } }` in workspace.jsonc.
|
|
469
|
+
|
|
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. Its components must still all live in this workspace's defaultScope |
|
|
473
|
+
|
|
474
|
+
| **Option** | **Option alias** | **Description** |
|
|
475
|
+
| ------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
476
|
+
| `--branch <branch>` | | Resolve the lane from this git branch name using the sync mapping config (cannot be combined with --all) |
|
|
477
|
+
| `--all` | | Reconcile every mapped lane plus the main scope (the default when no target is given; cannot be combined with a lane argument, --branch or --main) |
|
|
478
|
+
| `--main` | | Reconcile only the main scope against the default branch, opening a sync PR on drift (conflicts resolve in favour of the scope) |
|
|
479
|
+
| `--dry-run` | | Print the planned action per target. Nothing is pushed and no pull request is created or modified; the working tree is still written and then restored, so a dirty tree is refused rather than discarded |
|
|
480
|
+
| `--init` | | One-command onboarding: scaffold .github/workflows/bit-sync.yml + bit-release.yml (with this repository's actual default branch substituted), add the `"teambit.git/ci": { "sync": {} }` config block to workspace.jsonc if absent, and print the remaining manual-steps checklist (secrets + bit.cloud webhook). Writes nothing else and never overwrites an existing workflow file. Cannot be combined with a lane argument or any other flag. |
|
|
481
|
+
|
|
463
482
|
---
|
|
464
483
|
|
|
465
484
|
## clear-cache
|
package/dist/cli-reference.json
CHANGED
|
@@ -5129,6 +5129,47 @@
|
|
|
5129
5129
|
"extendedDescription": "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.",
|
|
5130
5130
|
"group": "collaborate",
|
|
5131
5131
|
"private": false
|
|
5132
|
+
},
|
|
5133
|
+
{
|
|
5134
|
+
"name": "sync [lane]",
|
|
5135
|
+
"alias": "",
|
|
5136
|
+
"options": [
|
|
5137
|
+
[
|
|
5138
|
+
"",
|
|
5139
|
+
"branch <branch>",
|
|
5140
|
+
"Resolve the lane from this git branch name using the sync mapping config (cannot be combined with --all)"
|
|
5141
|
+
],
|
|
5142
|
+
[
|
|
5143
|
+
"",
|
|
5144
|
+
"all",
|
|
5145
|
+
"Reconcile every mapped lane plus the main scope (the default when no target is given; cannot be combined with a lane argument, --branch or --main)"
|
|
5146
|
+
],
|
|
5147
|
+
[
|
|
5148
|
+
"",
|
|
5149
|
+
"main",
|
|
5150
|
+
"Reconcile only the main scope against the default branch, opening a sync PR on drift (conflicts resolve in favour of the scope)"
|
|
5151
|
+
],
|
|
5152
|
+
[
|
|
5153
|
+
"",
|
|
5154
|
+
"dry-run",
|
|
5155
|
+
"Print the planned action per target. Nothing is pushed and no pull request is created or modified; the working tree is still written and then restored, so a dirty tree is refused rather than discarded"
|
|
5156
|
+
],
|
|
5157
|
+
[
|
|
5158
|
+
"",
|
|
5159
|
+
"init",
|
|
5160
|
+
"One-command onboarding: scaffold .github/workflows/bit-sync.yml + bit-release.yml (with this repository's actual default branch substituted), add the `\"teambit.git/ci\": { \"sync\": {} }` config block to workspace.jsonc if absent, and print the remaining manual-steps checklist (secrets + bit.cloud webhook). Writes nothing else and never overwrites an existing workflow file. Cannot be combined with a lane argument or any other flag."
|
|
5161
|
+
]
|
|
5162
|
+
],
|
|
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 whose components are not all in this workspace's defaultScope is a cross-scope lane: no branch is created for it (it would leak another repository's components into this one) — enumerated runs skip it and stay green, an explicitly named one is refused, and a lane that became cross-scope after its branch existed is halted for a human. Configure mapping under `\"teambit.git/ci\": { \"sync\": { ... } }` in workspace.jsonc.",
|
|
5165
|
+
"group": "collaborate",
|
|
5166
|
+
"private": false,
|
|
5167
|
+
"arguments": [
|
|
5168
|
+
{
|
|
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. Its components must still all live in this workspace's defaultScope"
|
|
5171
|
+
}
|
|
5172
|
+
]
|
|
5132
5173
|
}
|
|
5133
5174
|
]
|
|
5134
5175
|
},
|