@teambit/harmony.content.cli-reference 2.0.1131 → 2.0.1132
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 +10 -0
- package/cli-reference.mdx +52 -50
- package/dist/cli-reference.docs.mdx +1 -1
- package/dist/cli-reference.json +10 -0
- package/dist/cli-reference.mdx.js +1 -1
- package/dist/cli-reference.mdx.js.map +1 -1
- package/dist/{preview-1784143869906.js → preview-1784148848422.js} +2 -2
- package/package.json +2 -2
package/cli-reference.docs.mdx
CHANGED
package/cli-reference.json
CHANGED
|
@@ -3485,6 +3485,11 @@
|
|
|
3485
3485
|
"pre-release [identifier]",
|
|
3486
3486
|
"syntactic sugar for \"--increment prerelease\" and `--prerelease-id <identifier>`"
|
|
3487
3487
|
],
|
|
3488
|
+
[
|
|
3489
|
+
"",
|
|
3490
|
+
"auto-tag-increment <level>",
|
|
3491
|
+
"the increment level to use for auto-tagged dependents. options are: [major, premajor, minor, preminor, patch, prepatch, prerelease].\nby default, dependents are bumped by a patch, unless --increment is one of [prepatch, prerelease, preminor, premajor], which they follow.\nnote that dependents are auto-tagged transitively, so the entire dependents graph is bumped by this level"
|
|
3492
|
+
],
|
|
3488
3493
|
[
|
|
3489
3494
|
"",
|
|
3490
3495
|
"snapped",
|
|
@@ -5064,6 +5069,11 @@
|
|
|
5064
5069
|
"pre-release [identifier]",
|
|
5065
5070
|
"syntactic sugar for \"--increment prerelease\" and `--prerelease-id <identifier>`"
|
|
5066
5071
|
],
|
|
5072
|
+
[
|
|
5073
|
+
"",
|
|
5074
|
+
"auto-tag-increment <level>",
|
|
5075
|
+
"the increment level to use for auto-tagged dependents. options are: [major, premajor, minor, preminor, patch, prepatch, prerelease].\nby default, dependents are bumped by a patch, unless --increment is one of [prepatch, prerelease, preminor, premajor], which they follow.\nnote that dependents are auto-tagged transitively, so the entire dependents graph is bumped by this level"
|
|
5076
|
+
],
|
|
5067
5077
|
[
|
|
5068
5078
|
"",
|
|
5069
5079
|
"increment-by <number>",
|
package/cli-reference.mdx
CHANGED
|
@@ -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
|
|
|
@@ -2732,37 +2733,38 @@ use for official releases. for development versions, use 'bit snap' instead.
|
|
|
2732
2733
|
| ----------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
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 are tagged. |
|
|
2734
2735
|
|
|
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
|
-
| `--
|
|
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
|
|
package/dist/cli-reference.json
CHANGED
|
@@ -3485,6 +3485,11 @@
|
|
|
3485
3485
|
"pre-release [identifier]",
|
|
3486
3486
|
"syntactic sugar for \"--increment prerelease\" and `--prerelease-id <identifier>`"
|
|
3487
3487
|
],
|
|
3488
|
+
[
|
|
3489
|
+
"",
|
|
3490
|
+
"auto-tag-increment <level>",
|
|
3491
|
+
"the increment level to use for auto-tagged dependents. options are: [major, premajor, minor, preminor, patch, prepatch, prerelease].\nby default, dependents are bumped by a patch, unless --increment is one of [prepatch, prerelease, preminor, premajor], which they follow.\nnote that dependents are auto-tagged transitively, so the entire dependents graph is bumped by this level"
|
|
3492
|
+
],
|
|
3488
3493
|
[
|
|
3489
3494
|
"",
|
|
3490
3495
|
"snapped",
|
|
@@ -5064,6 +5069,11 @@
|
|
|
5064
5069
|
"pre-release [identifier]",
|
|
5065
5070
|
"syntactic sugar for \"--increment prerelease\" and `--prerelease-id <identifier>`"
|
|
5066
5071
|
],
|
|
5072
|
+
[
|
|
5073
|
+
"",
|
|
5074
|
+
"auto-tag-increment <level>",
|
|
5075
|
+
"the increment level to use for auto-tagged dependents. options are: [major, premajor, minor, preminor, patch, prepatch, prerelease].\nby default, dependents are bumped by a patch, unless --increment is one of [prepatch, prerelease, preminor, premajor], which they follow.\nnote that dependents are auto-tagged transitively, so the entire dependents graph is bumped by this level"
|
|
5076
|
+
],
|
|
5067
5077
|
[
|
|
5068
5078
|
"",
|
|
5069
5079
|
"increment-by <number>",
|