@ferrflow/doc 7.28.6 → 7.30.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.
- package/changelog/2026-04-24-ferrflow-changelog-ordering.md +11 -0
- package/changelog/2026-04-28-ferrflow-editorial-hero.md +11 -0
- package/changelog/2026-04-29-ferrflow-docs-claude-style.md +22 -0
- package/changelog/2026-04-29-ferrflow-editorial-body.md +16 -0
- package/changelog/2026-04-29-ferrflow-v4-2-prerelease-channels.md +27 -0
- package/changelog/2026-05-05-ferrflow-do-not-track-and-first-run-notice.md +22 -0
- package/changelog/2026-06-07-ferrflow-bot-release-rulesets.md +29 -0
- package/changelog/2026-06-16-ferrflow-declarative-publishers.md +40 -0
- package/changelog/2026-06-25-ferrflow-jobs-flag.md +24 -0
- package/changelog/2026-06-25-ferrflow-publish-tag-scope.md +35 -0
- package/changelog/2026-06-26-ferrflow-arm-targets.md +24 -0
- package/changelog/2026-07-13-ferrflow-hook-points.md +32 -0
- package/changelog/2026-07-16-ferrflow-migrate-semantic-release.md +41 -0
- package/changelog/2026-07-17-ferrflow-linked-fixed-groups.md +23 -0
- package/changelog/2026-07-17-ferrflow-telemetry-removed.md +14 -0
- package/changelog/2026-07-18-ferrflow-bitbucket.md +20 -0
- package/changelog/2026-07-18-ferrflow-breaking-change-variants.md +20 -0
- package/changelog/2026-07-18-ferrflow-commit-graph.md +14 -0
- package/changelog/2026-07-18-ferrflow-doctor.md +21 -0
- package/changelog/2026-07-18-ferrflow-schema-subcommand.md +19 -0
- package/changelog/2026-07-18-ferrflow-selfhosted-forge-autodetect.md +19 -0
- package/changelog/2026-07-20-ferrflow-hook-all-packages.md +32 -0
- package/changelog/2026-07-20-ferrflow-rich-hook-context.md +35 -0
- package/changelog/2026-07-21-ferrflow-diff-command.md +20 -0
- package/changelog/2026-07-21-ferrflow-hook-release-url.md +27 -0
- package/changelog/2026-07-21-ferrflow-hosted-api.md +26 -0
- package/changelog/2026-07-21-ferrflow-migrate-js-yaml.md +19 -0
- package/changelog/2026-07-21-ferrflow-migrate-more-tools.md +24 -0
- package/changelog/2026-07-21-ferrflow-persistent-release-pr.md +17 -0
- package/changelog/2026-07-25-ferrflow-concurrent-release-replan.md +14 -0
- package/changelog/2026-07-27-ferrflow-cabal-cmake-formats.md +23 -0
- package/changelog/2026-07-27-ferrflow-cosign-bundles.md +25 -0
- package/changelog/2026-07-27-ferrflow-tags-before-releases.md +14 -0
- package/changelog/2026-07-28-ferrflow-changesets-workspace-discovery.md +17 -0
- package/changelog/2026-08-04-ferrflow-diff-package-scope.md +21 -0
- package/changelog/2026-08-05-ferrflow-api-own-domain.md +25 -0
- package/changelog/2026-08-07-ferrflow-action-input-hardening.md +18 -0
- package/changelog/2026-08-07-ferrflow-mit-license.md +26 -0
- package/changelog/2026-08-07-ferrflow-verified-installs.md +28 -0
- package/changelog/2026-08-10-ferrflow-commit-formats.md +46 -0
- package/changelog/2026-08-15-ferrflow-lockfile-refresh.md +16 -0
- package/changelog/2026-08-20-ferrflow-version-source-option.md +29 -0
- package/changelog/2026-08-20-ferrflow-version-source.md +23 -0
- package/changelog/2026-08-25-ferrflow-bot-verified-commits.md +19 -0
- package/changelog/2026-08-25-ferrflow-config-include.md +30 -0
- package/changelog/2026-08-25-ferrflow-pr-mode-tags-on-merge.md +21 -0
- package/changelog/2026-08-25-ferrflow-push-error-classification.md +24 -0
- package/changelog/2026-08-27-ferrflow-rollback.md +27 -0
- package/changelog/2026-08-27-ferrflow-workspace-defaults.md +34 -0
- package/changelog/2026-08-28-ferrflow-annotated-tag-deref.md +26 -0
- package/changelog/2026-08-28-ferrflow-cache-staleness.md +19 -0
- package/changelog/2026-08-28-ferrflow-cargo-publish-url.md +28 -0
- package/changelog/2026-08-28-ferrflow-npm-publish-url.md +27 -0
- package/changelog/2026-08-28-ferrflow-panic-cleanup.md +19 -0
- package/changelog/2026-08-29-ferrflow-calver-short-seq.md +31 -0
- package/changelog/2026-08-29-ferrflow-scoped-package-commits.md +23 -0
- package/changelog/2026-09-01-ferrflow-cascade-strongest-bump.md +25 -0
- package/changelog/2026-09-01-ferrflow-changelog-hook-rewrite.md +21 -0
- package/changelog/2026-09-01-ferrflow-doctor-lockfile.md +36 -0
- package/changelog/2026-09-01-ferrflow-graph-impact.md +34 -0
- package/changelog/2026-09-01-ferrflow-own-bump-raised.md +25 -0
- package/changelog/2026-09-02-ferrflow-galaxyyml.md +25 -0
- package/changelog/2026-09-03-ferrflow-docs-public.md +17 -0
- package/changelog/2026-09-04-ferrflow-build-metadata.md +27 -0
- package/changelog/2026-09-22-ferrflow-package-schema.md +31 -0
- package/changelog/2026-09-22-ferrflow-push-token-per-forge.md +23 -0
- package/changelog/2026-09-22-ferrflow-release-git-identity.md +18 -0
- package/changelog/2026-09-23-ferrflow-release-mr-title-length.md +21 -0
- package/changelog/2026-09-24-ferrflow-selector-padding.md +19 -0
- package/changelog/2026-09-24-ferrflow-template-leading-v.md +19 -0
- package/changelog/2026-09-24-ferrflow-template-literals.md +21 -0
- package/changelog/2026-09-28-ferrflow-floating-tag-backward.md +12 -0
- package/changelog/2026-09-28-ferrflow-helm-chart-name.md +12 -0
- package/changelog/2026-09-28-ferrflow-migrate-tag-template.md +23 -0
- package/changelog/2026-09-28-ferrflow-padded-versions.md +12 -0
- package/changelog/2026-10-02-ferrflow-shadow-release.md +17 -0
- package/changelog/2026-10-03-ferrflow-latest-tag-hotfix.md +13 -0
- package/changelog/2026-10-03-ferrflow-pr-lookup-branch-encoding.md +12 -0
- package/changelog/2026-10-03-ferrflow-preview-backtick.md +12 -0
- package/changelog/2026-10-03-ferrflow-why-doctor-wording.md +10 -0
- package/changelog/2026-10-07-ferrflow-strategy-names-json.md +12 -0
- package/changelog/2026-10-10-ferrflow-hook-timeout.md +23 -0
- package/changelog/2026-10-10-ferrflow-init-workspace-discovery.md +16 -0
- package/data/benchmarks.json +693 -693
- package/data/schema/ferrflow-package.json +6 -0
- package/data/schema/ferrflow.json +6 -0
- package/docs-en/configuration/config-file.md +3 -0
- package/docs-en/reference/cli.md +2 -0
- package/docs-fr/configuration/config-file.md +3 -0
- package/docs-fr/reference/cli.md +2 -0
- package/package.json +1 -1
|
@@ -692,6 +692,12 @@
|
|
|
692
692
|
"continue"
|
|
693
693
|
],
|
|
694
694
|
"default": "abort"
|
|
695
|
+
},
|
|
696
|
+
"timeout": {
|
|
697
|
+
"type": "integer",
|
|
698
|
+
"minimum": 1,
|
|
699
|
+
"description": "Seconds a hook may run before FerrFlow kills it and its child processes, then applies onFailure. Defaults to 900 (15 minutes).",
|
|
700
|
+
"default": 900
|
|
695
701
|
}
|
|
696
702
|
},
|
|
697
703
|
"additionalProperties": false
|
|
@@ -1167,6 +1167,12 @@
|
|
|
1167
1167
|
"continue"
|
|
1168
1168
|
],
|
|
1169
1169
|
"default": "abort"
|
|
1170
|
+
},
|
|
1171
|
+
"timeout": {
|
|
1172
|
+
"type": "integer",
|
|
1173
|
+
"minimum": 1,
|
|
1174
|
+
"description": "Seconds a hook may run before FerrFlow kills it and its child processes, then applies onFailure. Defaults to 900 (15 minutes).",
|
|
1175
|
+
"default": 900
|
|
1170
1176
|
}
|
|
1171
1177
|
},
|
|
1172
1178
|
"additionalProperties": false
|
|
@@ -778,6 +778,7 @@ on_failure = "abort"
|
|
|
778
778
|
| `onSuccess` | string | — | Run once after the whole release completes cleanly |
|
|
779
779
|
| `onError` | string | — | Run once when the release fails; sets `FERRFLOW_ERROR_CODE` (once per run) |
|
|
780
780
|
| `onFailure` | string | `"abort"` | Strategy — `"abort"` cancels the release on hook failure, `"continue"` prints a warning |
|
|
781
|
+
| `timeout` | number | `900` | Seconds a hook may run before it is killed and `onFailure` applies |
|
|
781
782
|
|
|
782
783
|
### Environment variables
|
|
783
784
|
|
|
@@ -807,6 +808,8 @@ For the once-per-run hooks (`preRelease`, `onSuccess`, `onError`) the per-packag
|
|
|
807
808
|
|
|
808
809
|
`onFailure` is the failure **strategy** (`abort` / `continue`), not a command. The command that runs _when_ a release fails is `onError`, which receives the failing `FERRFLOW_ERROR_CODE`.
|
|
809
810
|
|
|
811
|
+
Hooks run with stdin closed, so a command that would prompt (`npm login`, a `gpg` passphrase, a git credential prompt) fails at once instead of waiting forever. A hook still running after `timeout` seconds is killed along with any process it started, and counts as a failed hook: `abort` stops the release, `continue` warns and moves on. Every minute a long hook prints that it is still running. Set `timeout` per package to override the workspace value. On Linux and macOS a hook runs in its own process group so it can be killed with everything it started, which also means a Ctrl+C on an interactive `ferrflow release` stops FerrFlow but not a hook that is already running, and since the timeout is enforced by FerrFlow itself, that hook then runs until it finishes on its own.
|
|
812
|
+
|
|
810
813
|
### Per-package hooks
|
|
811
814
|
|
|
812
815
|
Package-level hooks **replace** workspace-level hooks for that package (they are not merged).
|
package/docs-en/reference/cli.md
CHANGED
|
@@ -169,6 +169,8 @@ ferrflow init [OPTIONS]
|
|
|
169
169
|
| ------------------- | ---------------------------------------------- |
|
|
170
170
|
| `--format <FORMAT>` | Config file format: `json`, `json5`, or `toml` |
|
|
171
171
|
|
|
172
|
+
If the repository declares a workspace, `init` lists the packages it found and offers to use them, one package per member with its manifest as the versioned file and a changelog next to it. It reads `workspaces` in `package.json`, `pnpm-workspace.yaml`, `[workspace] members` in `Cargo.toml`, `use` entries in `go.work` and `include` calls in `settings.gradle(.kts)`. Answer `n` to enter the packages by hand.
|
|
173
|
+
|
|
172
174
|
---
|
|
173
175
|
|
|
174
176
|
## `ferrflow migrate`
|
|
@@ -637,6 +637,7 @@ on_failure = "abort"
|
|
|
637
637
|
| `onSuccess` | string | — | Exécuté une fois après une release entièrement réussie |
|
|
638
638
|
| `onError` | string | — | Exécuté une fois quand la release échoue ; définit `FERRFLOW_ERROR_CODE` (une fois) |
|
|
639
639
|
| `onFailure` | string | `"abort"` | Stratégie — `"abort"` annule la release en cas d'échec de hook, `"continue"` affiche un avertissement |
|
|
640
|
+
| `timeout` | number | `900` | Secondes qu'un hook peut tourner avant d'être tué et que `onFailure` s'applique |
|
|
640
641
|
|
|
641
642
|
### Variables d'environnement
|
|
642
643
|
|
|
@@ -666,6 +667,8 @@ Pour les hooks exécutés une seule fois par run (`preRelease`, `onSuccess`, `on
|
|
|
666
667
|
|
|
667
668
|
`onFailure` est la **stratégie** d'échec (`abort` / `continue`), pas une commande. La commande exécutée _quand_ une release échoue est `onError`, qui reçoit le `FERRFLOW_ERROR_CODE` fautif.
|
|
668
669
|
|
|
670
|
+
Les hooks s'exécutent avec stdin fermé : une commande qui poserait une question (`npm login`, une passphrase `gpg`, une demande d'identifiants git) échoue tout de suite au lieu d'attendre indéfiniment. Un hook encore en cours après `timeout` secondes est tué avec les processus qu'il a lancés, et compte comme un hook en échec : `abort` arrête la release, `continue` affiche un avertissement et poursuit. Chaque minute, un hook long indique qu'il tourne toujours. `timeout` défini sur un package remplace la valeur du workspace. Sous Linux et macOS, un hook tourne dans son propre groupe de processus pour pouvoir être tué avec tout ce qu'il a lancé : un Ctrl+C sur un `ferrflow release` interactif arrête donc FerrFlow mais pas un hook déjà en cours, et comme le timeout est appliqué par FerrFlow lui-même, ce hook tourne alors jusqu'à ce qu'il se termine de lui-même.
|
|
671
|
+
|
|
669
672
|
### Hooks par package
|
|
670
673
|
|
|
671
674
|
Les hooks au niveau du package **remplacent** les hooks du workspace pour ce package (ils ne sont pas fusionnés).
|
package/docs-fr/reference/cli.md
CHANGED
|
@@ -138,6 +138,8 @@ ferrflow init [OPTIONS]
|
|
|
138
138
|
| ------------------- | -------------------------------------------------------------- |
|
|
139
139
|
| `--format <FORMAT>` | Format du fichier de configuration : `json`, `json5` ou `toml` |
|
|
140
140
|
|
|
141
|
+
Si le repository déclare un workspace, `init` liste les packages trouvés et propose de les utiliser, un package par membre avec son manifeste comme fichier versionné et un changelog à côté. Il lit `workspaces` dans `package.json`, `pnpm-workspace.yaml`, `[workspace] members` dans `Cargo.toml`, les entrées `use` de `go.work` et les appels `include` de `settings.gradle(.kts)`. Répondre `n` permet de saisir les packages à la main.
|
|
142
|
+
|
|
141
143
|
---
|
|
142
144
|
|
|
143
145
|
## `ferrflow migrate`
|