@ferrflow/doc 7.27.4 → 7.28.0
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.
|
@@ -225,6 +225,15 @@
|
|
|
225
225
|
".ferrflow.manifest.json"
|
|
226
226
|
]
|
|
227
227
|
},
|
|
228
|
+
"nestedPackages": {
|
|
229
|
+
"type": "string",
|
|
230
|
+
"enum": [
|
|
231
|
+
"shared",
|
|
232
|
+
"exclusive"
|
|
233
|
+
],
|
|
234
|
+
"description": "In a monorepo where one package's path contains another's, which packages a file under the inner path counts for. 'shared' (default) counts it for both, so a change in a nested package also bumps the package that contains it. 'exclusive' gives it to the package with the longest matching path only, so a nested package owns its subtree. `sharedPaths` still count as an explicit opt-in in both modes.",
|
|
235
|
+
"default": "shared"
|
|
236
|
+
},
|
|
228
237
|
"updateDependents": {
|
|
229
238
|
"type": "boolean",
|
|
230
239
|
"description": "When true, after `ferrflow release` bumps a package, every dependent listed via `dependsOn` has its version constraint for that package rewritten to the new version in its own manifest, and the manifest is staged in the release commit. Only `json` (package.json) and `toml` (Cargo.toml) manifests are rewritten, and only plain operator + version constraints (`^1.2.3`, `~1.2.3`, `1.2.3`) — a `workspace:*`, `file:`/`git:` spec or a multi-part range is left untouched for a human to handle.",
|
|
@@ -451,6 +460,15 @@
|
|
|
451
460
|
"description": "Snake_case form of `deferPublish` — both spellings are accepted. When true, `ferrflow release` does not run the configured publishers inline — it defers them to a separate `ferrflow publish` invocation (e.g. a CI job that carries the docker/helm/npm build toolchain the release job lacks). `ferrflow publish` always runs the publishers regardless of this flag.",
|
|
452
461
|
"default": false
|
|
453
462
|
},
|
|
463
|
+
"nested_packages": {
|
|
464
|
+
"type": "string",
|
|
465
|
+
"enum": [
|
|
466
|
+
"shared",
|
|
467
|
+
"exclusive"
|
|
468
|
+
],
|
|
469
|
+
"description": "Snake_case form of `nestedPackages`, both spellings are accepted. In a monorepo where one package's path contains another's, which packages a file under the inner path counts for. 'shared' (default) counts it for both, so a change in a nested package also bumps the package that contains it. 'exclusive' gives it to the package with the longest matching path only, so a nested package owns its subtree. `sharedPaths` still count as an explicit opt-in in both modes.",
|
|
470
|
+
"default": "shared"
|
|
471
|
+
},
|
|
454
472
|
"update_dependents": {
|
|
455
473
|
"type": "boolean",
|
|
456
474
|
"description": "Snake_case form of `updateDependents` — both spellings are accepted. When true, after `ferrflow release` bumps a package, every dependent listed via `dependsOn` has its version constraint for that package rewritten to the new version in its own manifest, and the manifest is staged in the release commit. Only `json` (package.json) and `toml` (Cargo.toml) manifests are rewritten, and only plain operator + version constraints (`^1.2.3`, `~1.2.3`, `1.2.3`) — a `workspace:*`, `file:`/`git:` spec or a multi-part range is left untouched for a human to handle.",
|
|
@@ -198,6 +198,7 @@ Global settings that apply to all packages.
|
|
|
198
198
|
| `versionSource` | string | `"highest"` | Which source wins when a package has both a git tag and a version in a versioned file. `"highest"` takes whichever is higher, so a mistake in either source ratchets the version upward and is never walked back. `"tag"` treats the tags as the record of what shipped and ignores the file. `"file"` treats the file as the source and ignores the tag, which is what a package migrated between repos usually needs. No effect when only one source is present. |
|
|
199
199
|
| `updateLockfiles` | boolean | `false` | After a bump, refresh the sibling lockfile (`Cargo.lock`, `package-lock.json` / `pnpm-lock.yaml` / `yarn.lock`, `poetry.lock` / `uv.lock`, `Gemfile.lock`, `mix.lock`) via the package manager's offline / lockfile-only mode and stage it in the same release commit. A missing package manager or an unresolvable offline update is warned about, never fatal. Set per-package `updateLockfiles: false` to opt a single package out. |
|
|
200
200
|
| `updateDependents` | boolean | `false` | After a bump, rewrite the version constraint every dependent declares for the bumped package and stage the manifest in the same release commit. Only `json` (`dependencies`, `devDependencies`, `peerDependencies`, `optionalDependencies`) and `toml` (`dependencies`, `dev-dependencies`, `build-dependencies`) manifests are rewritten, and only plain operator + version constraints — the operator is preserved (`^1.2.3` → `^2.0.0`). A `workspace:*`, `file:`/`git:` spec, `1.x` or a multi-part range is left untouched. |
|
|
201
|
+
| `nestedPackages` | string | `"shared"` | When one package's path contains another's, which packages a file under the inner path counts for. `shared` counts it for both; `exclusive` gives it to the package with the longest matching path. See [Nested packages](/docs/configuration/monorepo#nested-packages). |
|
|
201
202
|
| `floatingTags` | array | `[]` | Floating tag levels to create on each release: `"major"`, `"minor"`. For example, `["major"]` creates a `v1` tag that always points to the latest `v1.x.y` release. |
|
|
202
203
|
| `latestTag` | string | none | Template for a floating alias tag that always points at the package's newest non-prerelease release, e.g. `"latest"` or `"{name}@latest"`. Absent by default. Deliberately **not** derived from `tagTemplate`: the alias is a name, not a version, so a `tagTemplate` of `v{version}` yields `latest`, never `vlatest`. In a monorepo the template must contain `{name}`, otherwise every package overwrites the same ref and the last one released wins. Prereleases never move it, and neither does a hotfix on an older line: releasing 1.2.4 after 2.0.0 leaves it on 2.0.0 unless you pass `--force`. |
|
|
203
204
|
| `orphanedTagStrategy` | string | `"warn"` | How to handle tags pointing to orphaned commits after rebase + force-push: `"warn"`, `"treeHash"`, or `"message"` |
|
|
@@ -57,6 +57,22 @@ path = "packages/site"
|
|
|
57
57
|
</div></div>
|
|
58
58
|
</div>
|
|
59
59
|
|
|
60
|
+
### Nested packages
|
|
61
|
+
|
|
62
|
+
When one package's `path` contains another's, for example a root package at `.` and a CLI at `cli`, a file under `cli/` counts for both by default, so a change to the CLI also releases the root package. Set `workspace.nestedPackages` to `exclusive` to give each changed file to the package with the longest matching path only:
|
|
63
|
+
|
|
64
|
+
```json
|
|
65
|
+
{
|
|
66
|
+
"workspace": { "nestedPackages": "exclusive" },
|
|
67
|
+
"package": [
|
|
68
|
+
{ "name": "operator", "path": "." },
|
|
69
|
+
{ "name": "cli", "path": "cli" }
|
|
70
|
+
]
|
|
71
|
+
}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
A commit touching only `cli/` then releases the CLI alone, and a commit touching both trees releases both. `sharedPaths` stay an explicit opt-in: a file listed there still counts for that package, even inside a nested one. Narrowing the outer package's `path` is not an alternative, because publishers resolve their working directory from it.
|
|
75
|
+
|
|
60
76
|
## Shared dependencies
|
|
61
77
|
|
|
62
78
|
If you have code shared between packages (e.g., a `packages/shared/` library), declare it as a `sharedPaths` entry. A change to any shared path triggers a release for every package that lists it:
|
|
@@ -57,6 +57,22 @@ path = "packages/site"
|
|
|
57
57
|
</div></div>
|
|
58
58
|
</div>
|
|
59
59
|
|
|
60
|
+
### Packages imbriqués
|
|
61
|
+
|
|
62
|
+
Quand le `path` d'un package contient celui d'un autre, par exemple un package racine à `.` et un CLI à `cli`, un fichier sous `cli/` compte par défaut pour les deux : une modification du CLI publie aussi le package racine. Passez `workspace.nestedPackages` à `exclusive` pour attribuer chaque fichier modifié au seul package dont le chemin correspond le plus longuement :
|
|
63
|
+
|
|
64
|
+
```json
|
|
65
|
+
{
|
|
66
|
+
"workspace": { "nestedPackages": "exclusive" },
|
|
67
|
+
"package": [
|
|
68
|
+
{ "name": "operator", "path": "." },
|
|
69
|
+
{ "name": "cli", "path": "cli" }
|
|
70
|
+
]
|
|
71
|
+
}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Un commit qui ne touche que `cli/` publie alors le CLI seul, et un commit qui touche les deux arborescences publie les deux. Les `sharedPaths` restent un choix explicite : un fichier qui y figure compte toujours pour ce package, même à l'intérieur d'un package imbriqué. Réduire le `path` du package englobant n'est pas une alternative, car les publishers en déduisent leur répertoire de travail.
|
|
75
|
+
|
|
60
76
|
## Dépendances partagées
|
|
61
77
|
|
|
62
78
|
Si vous avez du code partagé entre packages (ex. une bibliothèque `packages/shared/`), déclarez-le comme entrée `sharedPaths`. Un changement dans un chemin partagé déclenche une release pour chaque package qui le référence :
|