@ferrflow/doc 7.35.6 → 7.36.1
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.
|
@@ -125,6 +125,52 @@
|
|
|
125
125
|
"zerover"
|
|
126
126
|
]
|
|
127
127
|
},
|
|
128
|
+
"preMajor": {
|
|
129
|
+
"type": "object",
|
|
130
|
+
"description": "Per-package override for workspace.preMajor. While the current major is 0 on a `semver` project, remaps the bump: `breaking` replaces what a breaking change bumps (normally major) and `feat` replaces what a `feat` bumps (normally minor). `{\"breaking\": \"minor\", \"feat\": \"patch\"}` matches release-please's bump-minor-pre-major and bump-patch-for-minor-pre-major. No effect from 1.0.0 on, leave 0.x with `ferrflow release --force-version 1.0.0`. Omit for the standard semver rules.",
|
|
131
|
+
"properties": {
|
|
132
|
+
"breaking": {
|
|
133
|
+
"type": "string",
|
|
134
|
+
"enum": [
|
|
135
|
+
"minor",
|
|
136
|
+
"patch"
|
|
137
|
+
],
|
|
138
|
+
"description": "Bump a breaking change takes while the current major is 0."
|
|
139
|
+
},
|
|
140
|
+
"feat": {
|
|
141
|
+
"type": "string",
|
|
142
|
+
"enum": [
|
|
143
|
+
"minor",
|
|
144
|
+
"patch"
|
|
145
|
+
],
|
|
146
|
+
"description": "Bump a `feat` commit takes while the current major is 0."
|
|
147
|
+
}
|
|
148
|
+
},
|
|
149
|
+
"additionalProperties": false
|
|
150
|
+
},
|
|
151
|
+
"pre_major": {
|
|
152
|
+
"type": "object",
|
|
153
|
+
"description": "Snake_case form of `preMajor`, both spellings are accepted. Per-package override for workspace.preMajor. While the current major is 0 on a `semver` project, remaps the bump: `breaking` replaces what a breaking change bumps (normally major) and `feat` replaces what a `feat` bumps (normally minor). `{\"breaking\": \"minor\", \"feat\": \"patch\"}` matches release-please's bump-minor-pre-major and bump-patch-for-minor-pre-major. No effect from 1.0.0 on, leave 0.x with `ferrflow release --force-version 1.0.0`. Omit for the standard semver rules.",
|
|
154
|
+
"properties": {
|
|
155
|
+
"breaking": {
|
|
156
|
+
"type": "string",
|
|
157
|
+
"enum": [
|
|
158
|
+
"minor",
|
|
159
|
+
"patch"
|
|
160
|
+
],
|
|
161
|
+
"description": "Bump a breaking change takes while the current major is 0."
|
|
162
|
+
},
|
|
163
|
+
"feat": {
|
|
164
|
+
"type": "string",
|
|
165
|
+
"enum": [
|
|
166
|
+
"minor",
|
|
167
|
+
"patch"
|
|
168
|
+
],
|
|
169
|
+
"description": "Bump a `feat` commit takes while the current major is 0."
|
|
170
|
+
}
|
|
171
|
+
},
|
|
172
|
+
"additionalProperties": false
|
|
173
|
+
},
|
|
128
174
|
"versionTemplate": {
|
|
129
175
|
"type": "string",
|
|
130
176
|
"description": "Version format built from named variables. Variables: year, short_year, month, padded_month, day, padded_day, week, padded_week, quarter, seq, major, minor, patch. Each must be separated by a literal so the previous version can be read back. The literals cannot carry whitespace, control characters, or the characters git reserves in a ref name (~ ^ : ? * [ backslash), because the version becomes a git tag. Overrides workspace default. Takes precedence over 'versioning'.",
|
|
@@ -54,6 +54,52 @@
|
|
|
54
54
|
],
|
|
55
55
|
"default": "semver"
|
|
56
56
|
},
|
|
57
|
+
"preMajor": {
|
|
58
|
+
"type": "object",
|
|
59
|
+
"description": "While the current major is 0 on a `semver` project, remaps the bump: `breaking` replaces what a breaking change bumps (normally major) and `feat` replaces what a `feat` bumps (normally minor). `{\"breaking\": \"minor\", \"feat\": \"patch\"}` matches release-please's bump-minor-pre-major and bump-patch-for-minor-pre-major. No effect from 1.0.0 on, leave 0.x with `ferrflow release --force-version 1.0.0`. Omit for the standard semver rules.",
|
|
60
|
+
"properties": {
|
|
61
|
+
"breaking": {
|
|
62
|
+
"type": "string",
|
|
63
|
+
"enum": [
|
|
64
|
+
"minor",
|
|
65
|
+
"patch"
|
|
66
|
+
],
|
|
67
|
+
"description": "Bump a breaking change takes while the current major is 0."
|
|
68
|
+
},
|
|
69
|
+
"feat": {
|
|
70
|
+
"type": "string",
|
|
71
|
+
"enum": [
|
|
72
|
+
"minor",
|
|
73
|
+
"patch"
|
|
74
|
+
],
|
|
75
|
+
"description": "Bump a `feat` commit takes while the current major is 0."
|
|
76
|
+
}
|
|
77
|
+
},
|
|
78
|
+
"additionalProperties": false
|
|
79
|
+
},
|
|
80
|
+
"pre_major": {
|
|
81
|
+
"type": "object",
|
|
82
|
+
"description": "Snake_case form of `preMajor`, both spellings are accepted. While the current major is 0 on a `semver` project, remaps the bump: `breaking` replaces what a breaking change bumps (normally major) and `feat` replaces what a `feat` bumps (normally minor). `{\"breaking\": \"minor\", \"feat\": \"patch\"}` matches release-please's bump-minor-pre-major and bump-patch-for-minor-pre-major. No effect from 1.0.0 on, leave 0.x with `ferrflow release --force-version 1.0.0`. Omit for the standard semver rules.",
|
|
83
|
+
"properties": {
|
|
84
|
+
"breaking": {
|
|
85
|
+
"type": "string",
|
|
86
|
+
"enum": [
|
|
87
|
+
"minor",
|
|
88
|
+
"patch"
|
|
89
|
+
],
|
|
90
|
+
"description": "Bump a breaking change takes while the current major is 0."
|
|
91
|
+
},
|
|
92
|
+
"feat": {
|
|
93
|
+
"type": "string",
|
|
94
|
+
"enum": [
|
|
95
|
+
"minor",
|
|
96
|
+
"patch"
|
|
97
|
+
],
|
|
98
|
+
"description": "Bump a `feat` commit takes while the current major is 0."
|
|
99
|
+
}
|
|
100
|
+
},
|
|
101
|
+
"additionalProperties": false
|
|
102
|
+
},
|
|
57
103
|
"versionTemplate": {
|
|
58
104
|
"type": "string",
|
|
59
105
|
"description": "Version format built from named variables. Variables: year, short_year, month, padded_month, day, padded_day, week, padded_week, quarter, seq, major, minor, patch. Each must be separated by a literal so the previous version can be read back. The literals cannot carry whitespace, control characters, or the characters git reserves in a ref name (~ ^ : ? * [ backslash), because the version becomes a git tag. Takes precedence over 'versioning'.",
|
|
@@ -630,6 +676,52 @@
|
|
|
630
676
|
"zerover"
|
|
631
677
|
]
|
|
632
678
|
},
|
|
679
|
+
"preMajor": {
|
|
680
|
+
"type": "object",
|
|
681
|
+
"description": "Per-package override for workspace.preMajor. While the current major is 0 on a `semver` project, remaps the bump: `breaking` replaces what a breaking change bumps (normally major) and `feat` replaces what a `feat` bumps (normally minor). `{\"breaking\": \"minor\", \"feat\": \"patch\"}` matches release-please's bump-minor-pre-major and bump-patch-for-minor-pre-major. No effect from 1.0.0 on, leave 0.x with `ferrflow release --force-version 1.0.0`. Omit for the standard semver rules.",
|
|
682
|
+
"properties": {
|
|
683
|
+
"breaking": {
|
|
684
|
+
"type": "string",
|
|
685
|
+
"enum": [
|
|
686
|
+
"minor",
|
|
687
|
+
"patch"
|
|
688
|
+
],
|
|
689
|
+
"description": "Bump a breaking change takes while the current major is 0."
|
|
690
|
+
},
|
|
691
|
+
"feat": {
|
|
692
|
+
"type": "string",
|
|
693
|
+
"enum": [
|
|
694
|
+
"minor",
|
|
695
|
+
"patch"
|
|
696
|
+
],
|
|
697
|
+
"description": "Bump a `feat` commit takes while the current major is 0."
|
|
698
|
+
}
|
|
699
|
+
},
|
|
700
|
+
"additionalProperties": false
|
|
701
|
+
},
|
|
702
|
+
"pre_major": {
|
|
703
|
+
"type": "object",
|
|
704
|
+
"description": "Snake_case form of `preMajor`, both spellings are accepted. Per-package override for workspace.preMajor. While the current major is 0 on a `semver` project, remaps the bump: `breaking` replaces what a breaking change bumps (normally major) and `feat` replaces what a `feat` bumps (normally minor). `{\"breaking\": \"minor\", \"feat\": \"patch\"}` matches release-please's bump-minor-pre-major and bump-patch-for-minor-pre-major. No effect from 1.0.0 on, leave 0.x with `ferrflow release --force-version 1.0.0`. Omit for the standard semver rules.",
|
|
705
|
+
"properties": {
|
|
706
|
+
"breaking": {
|
|
707
|
+
"type": "string",
|
|
708
|
+
"enum": [
|
|
709
|
+
"minor",
|
|
710
|
+
"patch"
|
|
711
|
+
],
|
|
712
|
+
"description": "Bump a breaking change takes while the current major is 0."
|
|
713
|
+
},
|
|
714
|
+
"feat": {
|
|
715
|
+
"type": "string",
|
|
716
|
+
"enum": [
|
|
717
|
+
"minor",
|
|
718
|
+
"patch"
|
|
719
|
+
],
|
|
720
|
+
"description": "Bump a `feat` commit takes while the current major is 0."
|
|
721
|
+
}
|
|
722
|
+
},
|
|
723
|
+
"additionalProperties": false
|
|
724
|
+
},
|
|
633
725
|
"versionTemplate": {
|
|
634
726
|
"type": "string",
|
|
635
727
|
"description": "Version format built from named variables. Variables: year, short_year, month, padded_month, day, padded_day, week, padded_week, quarter, seq, major, minor, patch. Each must be separated by a literal so the previous version can be read back. The literals cannot carry whitespace, control characters, or the characters git reserves in a ref name (~ ^ : ? * [ backslash), because the version becomes a git tag. Overrides workspace default. Takes precedence over 'versioning'.",
|
|
@@ -186,6 +186,7 @@ Global settings that apply to all packages.
|
|
|
186
186
|
| `branch` | string | auto-detected | Branch to push to (detected from remote HEAD) |
|
|
187
187
|
| `tagTemplate` | string | `"v{version}"` or `"{name}@v{version}"` | Tag naming pattern. Uses `{version}` and `{name}` placeholders. Defaults to `v{version}` for single-package repos and `{name}@v{version}` for monorepos. |
|
|
188
188
|
| `versioning` | string | `"semver"` | Default versioning strategy for all packages |
|
|
189
|
+
| `preMajor` | object | unset | Remaps the bump of a `semver` project while its major is 0, see [Pre-1.0 bump rules](#pre-10-bump-rules) |
|
|
189
190
|
| `releaseCommitMode` | string | `"commit"` | How to handle the release commit: `"commit"`, `"pr"`, or `"none"` |
|
|
190
191
|
| `releaseCommitScope` | string | `"grouped"` | In a monorepo where several packages are bumped at once, whether to create a single `"grouped"` commit or one commit `"per-package"`. Only matters when multiple packages bump. |
|
|
191
192
|
| `releaseCommitBody` | string | `"none"` | What goes in the body of the release commit, below the subject. `"none"` keeps the single-line subject. `"summary"` lists one line per released package with its commit count. `"full"` embeds the changelog section written for each package — under `"grouped"` scope each section is headed `## <package> <version>`. |
|
|
@@ -404,6 +405,39 @@ versioning = "calver"
|
|
|
404
405
|
</div></div>
|
|
405
406
|
</div>
|
|
406
407
|
|
|
408
|
+
### Pre-1.0 bump rules
|
|
409
|
+
|
|
410
|
+
By default a `semver` project jumps to `1.0.0` on its first breaking change. `preMajor` keeps a 0.x project in initial development instead: while the current major is `0`, a breaking change bumps what `breaking` says and a `feat` bumps what `feat` says (`minor` or `patch`). `fix` is unaffected. Both keys are optional.
|
|
411
|
+
|
|
412
|
+
<div class="ferr-tabs">
|
|
413
|
+
<div class="ferr-tab" data-label="JSON"><p class="ferr-tab__label">JSON</p><div class="ferr-tab__body"><pre><code class="language-json">{
|
|
414
|
+
"workspace": {
|
|
415
|
+
"versioning": "semver",
|
|
416
|
+
"preMajor": { "breaking": "minor", "feat": "patch" }
|
|
417
|
+
}
|
|
418
|
+
}
|
|
419
|
+
</code></pre>
|
|
420
|
+
</div></div>
|
|
421
|
+
<div class="ferr-tab" data-label="TOML"><p class="ferr-tab__label">TOML</p><div class="ferr-tab__body"><pre><code class="language-toml">[workspace]
|
|
422
|
+
versioning = "semver"
|
|
423
|
+
|
|
424
|
+
[workspace.preMajor]
|
|
425
|
+
breaking = "minor"
|
|
426
|
+
feat = "patch"
|
|
427
|
+
</code></pre>
|
|
428
|
+
</div></div>
|
|
429
|
+
<div class="ferr-tab" data-label="JSON5"><p class="ferr-tab__label">JSON5</p><div class="ferr-tab__body"><pre><code class="language-json5">{
|
|
430
|
+
workspace: {
|
|
431
|
+
versioning: "semver",
|
|
432
|
+
preMajor: { breaking: "minor", feat: "patch" },
|
|
433
|
+
},
|
|
434
|
+
}
|
|
435
|
+
</code></pre>
|
|
436
|
+
</div></div>
|
|
437
|
+
</div>
|
|
438
|
+
|
|
439
|
+
From `0.5.0`: `feat!` gives `0.6.0`, `feat` and `fix` give `0.5.1`. This is release-please's `bump-minor-pre-major` plus `bump-patch-for-minor-pre-major`. From `1.0.0` on the setting has no effect, and `ferrflow release --force-version 1.0.0` leaves 0.x. It applies to the `semver` strategy only, and a package can override it with its own `preMajor`. Unset keeps the standard rules.
|
|
440
|
+
|
|
407
441
|
### Pre-release channels
|
|
408
442
|
|
|
409
443
|
The `branches` array maps branch names (or glob patterns) to pre-release channels. When FerrFlow runs on a branch matching an entry, it releases on that channel — e.g. `1.4.0-beta.1` instead of `1.4.0`. The same mapping is what `--channel` on `ferrflow check` and `ferrflow release` overrides ad-hoc.
|
|
@@ -578,6 +612,7 @@ Defines a package to version. You can have one or many.
|
|
|
578
612
|
| `sharedPaths` | no | `[]` | Paths that trigger this package when changed |
|
|
579
613
|
| `dependsOn` | no | `[]` | Packages this package depends on. When a dependency is bumped, this package is bumped too — with the same bump type by default. Each entry is a package name, or `{ "name": "core", "propagate": "patch" }` to choose the policy (`same`, `major-on-major`, `patch`, `none`). |
|
|
580
614
|
| `versioning` | no | inherited from workspace | Override versioning strategy for this package |
|
|
615
|
+
| `preMajor` | no | inherited from workspace | Override the pre-1.0 bump rules for this package |
|
|
581
616
|
| `tagTemplate` | no | inherited from workspace | Override tag template for this package |
|
|
582
617
|
| `floatingTags` | no | inherited from workspace | Override floating tags for this package |
|
|
583
618
|
| `latestTag` | no | inherited from workspace | Override the floating alias tag for this package |
|
|
@@ -186,6 +186,7 @@ Paramètres globaux qui s'appliquent à tous les packages.
|
|
|
186
186
|
| `tagTemplate` | string | `"v{version}"` ou `"{name}@v{version}"` | Modèle de nommage des tags. Utilise les placeholders `{version}` et `{name}`. Par défaut `v{version}` pour les repos mono-package et `{name}@v{version}` pour les monorepos. |
|
|
187
187
|
| `latestTag` | string | aucun | Modèle d'un tag alias flottant qui pointe toujours vers la dernière version non-préversion du package, par exemple `"latest"` ou `"{name}@latest"`. Absent par défaut. Volontairement **non** dérivé de `tagTemplate` : l'alias est un nom, pas une version, donc un `tagTemplate` en `v{version}` donne `latest`, jamais `vlatest`. En monorepo le modèle doit contenir `{name}`, sinon chaque package écrase le même ref et le dernier publié gagne. Les préversions ne le déplacent jamais, pas plus qu'un hotfix sur une ligne plus ancienne : publier 1.2.4 après 2.0.0 le laisse sur 2.0.0, sauf avec `--force`. |
|
|
188
188
|
| `versioning` | string | `"semver"` | Stratégie de versionnage par défaut pour tous les packages |
|
|
189
|
+
| `preMajor` | object | unset | Remappe le bump d'un projet `semver` tant que sa majeure vaut 0, voir [Règles de bump avant 1.0](#regles-de-bump-avant-10) |
|
|
189
190
|
| `releaseCommitMode` | string | `"commit"` | Gestion du commit de release : `"commit"`, `"pr"` ou `"none"` |
|
|
190
191
|
| `releaseCommitScope` | string | `"grouped"` | Dans un monorepo où plusieurs packages sont bumpés en même temps, créer un seul commit `"grouped"` ou un commit `"per-package"`. N'a d'effet que quand plusieurs packages bumpent. |
|
|
191
192
|
| `releaseCommitBody` | string | `"none"` | Ce que contient le corps du commit de release, sous la ligne de sujet. `"none"` conserve le sujet sur une seule ligne. `"summary"` liste une ligne par package publié avec son nombre de commits. `"full"` intègre la section de changelog écrite pour chaque package — en scope `"grouped"`, chaque section est titrée `## <package> <version>`. |
|
|
@@ -328,6 +329,39 @@ versioning = "calver"
|
|
|
328
329
|
</div></div>
|
|
329
330
|
</div>
|
|
330
331
|
|
|
332
|
+
### Règles de bump avant 1.0
|
|
333
|
+
|
|
334
|
+
Par défaut, un projet `semver` passe à `1.0.0` dès son premier changement cassant. `preMajor` garde un projet 0.x en développement initial : tant que la majeure courante est `0`, un changement cassant bumpe selon `breaking` et un `feat` selon `feat` (`minor` ou `patch`). `fix` n'est pas touché. Les deux clés sont optionnelles.
|
|
335
|
+
|
|
336
|
+
<div class="ferr-tabs">
|
|
337
|
+
<div class="ferr-tab" data-label="JSON"><p class="ferr-tab__label">JSON</p><div class="ferr-tab__body"><pre><code class="language-json">{
|
|
338
|
+
"workspace": {
|
|
339
|
+
"versioning": "semver",
|
|
340
|
+
"preMajor": { "breaking": "minor", "feat": "patch" }
|
|
341
|
+
}
|
|
342
|
+
}
|
|
343
|
+
</code></pre>
|
|
344
|
+
</div></div>
|
|
345
|
+
<div class="ferr-tab" data-label="TOML"><p class="ferr-tab__label">TOML</p><div class="ferr-tab__body"><pre><code class="language-toml">[workspace]
|
|
346
|
+
versioning = "semver"
|
|
347
|
+
|
|
348
|
+
[workspace.preMajor]
|
|
349
|
+
breaking = "minor"
|
|
350
|
+
feat = "patch"
|
|
351
|
+
</code></pre>
|
|
352
|
+
</div></div>
|
|
353
|
+
<div class="ferr-tab" data-label="JSON5"><p class="ferr-tab__label">JSON5</p><div class="ferr-tab__body"><pre><code class="language-json5">{
|
|
354
|
+
workspace: {
|
|
355
|
+
versioning: "semver",
|
|
356
|
+
preMajor: { breaking: "minor", feat: "patch" },
|
|
357
|
+
},
|
|
358
|
+
}
|
|
359
|
+
</code></pre>
|
|
360
|
+
</div></div>
|
|
361
|
+
</div>
|
|
362
|
+
|
|
363
|
+
Depuis `0.5.0` : `feat!` donne `0.6.0`, `feat` et `fix` donnent `0.5.1`. C'est l'équivalent de `bump-minor-pre-major` et `bump-patch-for-minor-pre-major` de release-please. À partir de `1.0.0` le réglage n'a plus d'effet, et `ferrflow release --force-version 1.0.0` sort de 0.x. Il ne s'applique qu'à la stratégie `semver`, et un package peut le surcharger avec son propre `preMajor`. Non défini, les règles standard s'appliquent.
|
|
364
|
+
|
|
331
365
|
### Canaux de pré-release
|
|
332
366
|
|
|
333
367
|
Le tableau `branches` associe des noms de branches (ou des motifs glob) à des canaux de pré-release. Quand FerrFlow s'exécute sur une branche correspondant à une entrée, il release sur ce canal — par exemple `1.4.0-beta.1` au lieu de `1.4.0`. C'est cette même association que l'option `--channel` de `ferrflow check` et `ferrflow release` surcharge ponctuellement.
|
|
@@ -417,6 +451,7 @@ Définit un package à versionner. Vous pouvez en avoir un ou plusieurs.
|
|
|
417
451
|
| `changelog` | non | `{path}/CHANGELOG.md` | Chemin vers le fichier changelog |
|
|
418
452
|
| `sharedPaths` | non | `[]` | Chemins qui déclenchent ce package lorsqu'ils sont modifiés |
|
|
419
453
|
| `versioning` | non | hérité du workspace | Surcharger la stratégie de versionnage pour ce package |
|
|
454
|
+
| `preMajor` | non | hérité du workspace | Surcharger les règles de bump avant 1.0 pour ce package |
|
|
420
455
|
| `tagTemplate` | non | hérité du workspace | Surcharger le modèle de tag pour ce package |
|
|
421
456
|
| `latestTag` | non | hérité du workspace | Surcharger le tag alias flottant pour ce package |
|
|
422
457
|
| `buildMetadata` | non | hérité du workspace | Surcharger la commande de métadonnées, ou `false` pour une version nue |
|