@teambit/harmony.content.cli-reference 2.0.737 → 2.0.739

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,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.12.91'
2
+ description: 'Bit command synopses. Bit version: 1.12.93'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -4172,8 +4172,8 @@
4172
4172
  "name": "verify",
4173
4173
  "alias": "",
4174
4174
  "options": [],
4175
- "description": "CI commands",
4176
- "extendedDescription": "",
4175
+ "description": "Ensures the workspace passes CI checks on every commit.",
4176
+ "extendedDescription": "Runs lint, build, and status checks to catch dependency drift or broken builds early. Typically used as a pre-push hook or early CI job. Stops at the first failing step and returns a non-zero exit code.",
4177
4177
  "group": "development",
4178
4178
  "private": false
4179
4179
  },
@@ -4202,8 +4202,8 @@
4202
4202
  "Set to true to fail on warnings as well as errors, false (default) only fails on errors"
4203
4203
  ]
4204
4204
  ],
4205
- "description": "This command is meant to run when a PR was open/updated and meant to export a lane to bit-cloud.",
4206
- "extendedDescription": "",
4205
+ "description": "Exports a feature lane to Bit Cloud when a Pull Request is opened or updated.",
4206
+ "extendedDescription": "Resolves the lane name from --lane or the current Git branch, validates it, and runs install, status, snap, and export. Cleans up by switching back to main. Use in pull-request CI pipelines after tests and before deploy.",
4207
4207
  "group": "collaborate",
4208
4208
  "private": false
4209
4209
  },
@@ -4287,8 +4287,8 @@
4287
4287
  "specify the lane name to delete after merge (auto-detected if not provided)"
4288
4288
  ]
4289
4289
  ],
4290
- "description": "Merges a PR",
4291
- "extendedDescription": "",
4290
+ "description": "Tags and exports new semantic versions after merging a PR to main.",
4291
+ "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.",
4292
4292
  "group": "collaborate",
4293
4293
  "private": false
4294
4294
  }
package/cli-reference.mdx CHANGED
@@ -355,13 +355,15 @@ when on a lane, "checkout head" only checks out components on this lane. to upda
355
355
 
356
356
  **Usage**: `ci verify`
357
357
 
358
- **Description**: CI commands
358
+ **Description**: Ensures the workspace passes CI checks on every commit.
359
+ Runs lint, build, and status checks to catch dependency drift or broken builds early. Typically used as a pre-push hook or early CI job. Stops at the first failing step and returns a non-zero exit code.
359
360
 
360
361
  ### ci pr
361
362
 
362
363
  **Usage**: `ci pr`
363
364
 
364
- **Description**: This command is meant to run when a PR was open/updated and meant to export a lane to bit-cloud.
365
+ **Description**: Exports a feature lane to Bit Cloud when a Pull Request is opened or updated.
366
+ Resolves the lane name from --lane or the current Git branch, validates it, and runs install, status, snap, and export. Cleans up by switching back to main. Use in pull-request CI pipelines after tests and before deploy.
365
367
 
366
368
  | **Option** | **Option alias** | **Description** |
367
369
  | --------------------- | :--------------: | --------------------------------------------------------------------------------------- |
@@ -374,7 +376,8 @@ when on a lane, "checkout head" only checks out components on this lane. to upda
374
376
 
375
377
  **Usage**: `ci merge`
376
378
 
377
- **Description**: Merges a PR
379
+ **Description**: Tags and exports new semantic versions after merging a PR to main.
380
+ 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.
378
381
 
379
382
  | **Option** | **Option alias** | **Description** |
380
383
  | --------------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------- |
@@ -1,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.12.91'
2
+ description: 'Bit command synopses. Bit version: 1.12.93'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -4172,8 +4172,8 @@
4172
4172
  "name": "verify",
4173
4173
  "alias": "",
4174
4174
  "options": [],
4175
- "description": "CI commands",
4176
- "extendedDescription": "",
4175
+ "description": "Ensures the workspace passes CI checks on every commit.",
4176
+ "extendedDescription": "Runs lint, build, and status checks to catch dependency drift or broken builds early. Typically used as a pre-push hook or early CI job. Stops at the first failing step and returns a non-zero exit code.",
4177
4177
  "group": "development",
4178
4178
  "private": false
4179
4179
  },
@@ -4202,8 +4202,8 @@
4202
4202
  "Set to true to fail on warnings as well as errors, false (default) only fails on errors"
4203
4203
  ]
4204
4204
  ],
4205
- "description": "This command is meant to run when a PR was open/updated and meant to export a lane to bit-cloud.",
4206
- "extendedDescription": "",
4205
+ "description": "Exports a feature lane to Bit Cloud when a Pull Request is opened or updated.",
4206
+ "extendedDescription": "Resolves the lane name from --lane or the current Git branch, validates it, and runs install, status, snap, and export. Cleans up by switching back to main. Use in pull-request CI pipelines after tests and before deploy.",
4207
4207
  "group": "collaborate",
4208
4208
  "private": false
4209
4209
  },
@@ -4287,8 +4287,8 @@
4287
4287
  "specify the lane name to delete after merge (auto-detected if not provided)"
4288
4288
  ]
4289
4289
  ],
4290
- "description": "Merges a PR",
4291
- "extendedDescription": "",
4290
+ "description": "Tags and exports new semantic versions after merging a PR to main.",
4291
+ "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.",
4292
4292
  "group": "collaborate",
4293
4293
  "private": false
4294
4294
  }
@@ -1874,13 +1874,17 @@ function MDXContent(_ref) {
1874
1874
  parentName: "p"
1875
1875
  }, "ci verify")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1876
1876
  parentName: "p"
1877
- }, "Description"), ": CI commands"), (0, _react2.mdx)("h3", null, "ci pr"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1877
+ }, "Description"), ": Ensures the workspace passes CI checks on every commit.", (0, _react2.mdx)("br", {
1878
+ parentName: "p"
1879
+ }), "\n", "Runs lint, build, and status checks to catch dependency drift or broken builds early. Typically used as a pre-push hook or early CI job. Stops at the first failing step and returns a non-zero exit code."), (0, _react2.mdx)("h3", null, "ci pr"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1878
1880
  parentName: "p"
1879
1881
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
1880
1882
  parentName: "p"
1881
1883
  }, "ci pr")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1882
1884
  parentName: "p"
1883
- }, "Description"), ": This command is meant to run when a PR was open/updated and meant to export a lane to bit-cloud."), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1885
+ }, "Description"), ": Exports a feature lane to Bit Cloud when a Pull Request is opened or updated.", (0, _react2.mdx)("br", {
1886
+ parentName: "p"
1887
+ }), "\n", "Resolves the lane name from --lane or the current Git branch, validates it, and runs install, status, snap, and export. Cleans up by switching back to main. Use in pull-request CI pipelines after tests and before deploy."), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1884
1888
  parentName: "table"
1885
1889
  }, (0, _react2.mdx)("tr", {
1886
1890
  parentName: "thead"
@@ -1967,7 +1971,9 @@ function MDXContent(_ref) {
1967
1971
  parentName: "p"
1968
1972
  }, "ci merge")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1969
1973
  parentName: "p"
1970
- }, "Description"), ": Merges a PR"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1974
+ }, "Description"), ": Tags and exports new semantic versions after merging a PR to main.", (0, _react2.mdx)("br", {
1975
+ parentName: "p"
1976
+ }), "\n", "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."), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1971
1977
  parentName: "table"
1972
1978
  }, (0, _react2.mdx)("tr", {
1973
1979
  parentName: "thead"