@ferrflow/doc 7.26.13 → 7.27.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.
@@ -46,7 +46,7 @@ curl "https://api.ferrflow.com/v1/ferrflow/latest?platform=linux-x64"
46
46
  }
47
47
  ```
48
48
 
49
- Releases are signed with [Sigstore](/verifying-releases/): verify the `.bundle` rather than a checksum (releases up to v5.47.4 carry a `.sig` + `.crt` pair instead). Without `platform`, the response lists `assets` for every platform. Valid platforms: `linux-x64`, `linux-arm64`, `linux-arm`, `darwin-x64`, `darwin-arm64`, `win32-x64`, `win32-arm64`.
49
+ Releases are signed with [Sigstore](/docs/verifying-releases/): verify the `.bundle` rather than a checksum (releases up to v5.47.4 carry a `.sig` + `.crt` pair instead). Without `platform`, the response lists `assets` for every platform. Valid platforms: `linux-x64`, `linux-arm64`, `linux-arm`, `darwin-x64`, `darwin-arm64`, `win32-x64`, `win32-arm64`.
50
50
 
51
51
  ## `POST /v1/ferrflow/validate`
52
52
 
@@ -62,6 +62,26 @@ From there the first `feat:` commit bumps to `0.1.0` / `1` / today's date / …
62
62
 
63
63
  ---
64
64
 
65
+ ## `ferrflow shadow-release`
66
+
67
+ Run the whole release in a throwaway clone of the repository, so you can see what a real release would do and whether it would get through.
68
+
69
+ ```bash
70
+ ferrflow shadow-release [--keep]
71
+ ```
72
+
73
+ | Flag | Description |
74
+ | -------- | ------------------------------------------------ |
75
+ | `--keep` | Keep the clone and print its path for inspection |
76
+
77
+ The clone gets everything `release` does locally: versioned files, changelogs, the release commit, tags and floating tags. Pre-commit, post-commit, pre-tag, post-tag and pre-publish hooks run for real, so a hook that would fail the release fails here too. Nothing leaves the machine: no push, no forge release, no draft promotion, no post-publish, `onSuccess` or `onError` hook, and no publisher. The repository you ran it from is not modified.
78
+
79
+ With `releaseCommitMode: "pr"`, the clone gets the commit and tags that land once the release PR is merged, not the PR itself.
80
+
81
+ At the end it lists the commits, the files written and the tags created, then deletes the clone unless `--keep` is set. It exits non-zero with the failing step's error code when any step fails, so a CI job can gate on it.
82
+
83
+ ---
84
+
65
85
  ## `ferrflow check`
66
86
 
67
87
  Preview what `ferrflow release` would do without making any changes.
@@ -268,6 +268,12 @@ After pushing, the release commit could not be verified on the remote branch.
268
268
 
269
269
  The remote branch was not found after a push operation.
270
270
 
271
+ ### E2016: Shadow clone failed
272
+
273
+ <span id="e2016"></span>
274
+
275
+ `ferrflow shadow-release` could not clone the repository into a temporary directory. Check that git is on the `PATH` and that the system temp directory is writable.
276
+
271
277
  ## GitHub API Errors
272
278
 
273
279
  ### E3001: Failed to create release
@@ -46,7 +46,7 @@ curl "https://api.ferrflow.com/v1/ferrflow/latest?platform=linux-x64"
46
46
  }
47
47
  ```
48
48
 
49
- Les releases sont signées avec [Sigstore](/fr/verifying-releases/) : vérifiez le `.bundle` plutôt qu'une somme de contrôle (les releases jusqu'à v5.47.4 embarquent une paire `.sig` + `.crt`). Sans `platform`, la réponse liste les `assets` de chaque plateforme. Plateformes valides : `linux-x64`, `linux-arm64`, `linux-arm`, `darwin-x64`, `darwin-arm64`, `win32-x64`, `win32-arm64`.
49
+ Les releases sont signées avec [Sigstore](/fr/docs/verifying-releases/) : vérifiez le `.bundle` plutôt qu'une somme de contrôle (les releases jusqu'à v5.47.4 embarquent une paire `.sig` + `.crt`). Sans `platform`, la réponse liste les `assets` de chaque plateforme. Plateformes valides : `linux-x64`, `linux-arm64`, `linux-arm`, `darwin-x64`, `darwin-arm64`, `win32-x64`, `win32-arm64`.
50
50
 
51
51
  ## `POST /v1/ferrflow/validate`
52
52
 
@@ -31,6 +31,26 @@ ferrflow release [OPTIONS]
31
31
 
32
32
  ---
33
33
 
34
+ ## `ferrflow shadow-release`
35
+
36
+ Exécuter toute la release dans un clone jetable du dépôt, pour voir ce qu'une vraie release ferait et si elle passerait.
37
+
38
+ ```bash
39
+ ferrflow shadow-release [--keep]
40
+ ```
41
+
42
+ | Option | Description |
43
+ | -------- | ---------------------------------------------------------- |
44
+ | `--keep` | Conserver le clone et afficher son chemin pour l'inspecter |
45
+
46
+ Le clone reçoit tout ce que `release` fait en local : fichiers versionnés, changelogs, commit de release, tags et tags flottants. Les hooks pre-commit, post-commit, pre-tag, post-tag et pre-publish s'exécutent réellement, donc un hook qui ferait échouer la release échoue ici aussi. Rien ne sort de la machine : pas de push, pas de release sur la forge, pas de publication des brouillons, pas de hook post-publish, `onSuccess` ou `onError`, ni de publisher. Le dépôt d'origine n'est pas modifié.
47
+
48
+ Avec `releaseCommitMode: "pr"`, le clone reçoit le commit et les tags qui arrivent une fois la PR de release mergée, pas la PR elle-même.
49
+
50
+ À la fin, la commande liste les commits, les fichiers écrits et les tags créés, puis supprime le clone sauf avec `--keep`. Elle sort avec un code non nul et le code d'erreur de l'étape fautive dès qu'une étape échoue, pour qu'un job de CI puisse s'en servir comme garde-fou.
51
+
52
+ ---
53
+
34
54
  ## `ferrflow check`
35
55
 
36
56
  Prévisualiser ce que `ferrflow release` ferait sans effectuer de changements.
@@ -265,6 +265,12 @@ Le commit de release n'a pas pu être vérifié sur la branche distante.
265
265
 
266
266
  La branche distante n'a pas été trouvée après le push.
267
267
 
268
+ ### E2016 : Clone de shadow-release échoué
269
+
270
+ <span id="e2016"></span>
271
+
272
+ `ferrflow shadow-release` n'a pas pu cloner le dépôt dans un répertoire temporaire. Vérifiez que git est dans le `PATH` et que le répertoire temporaire du système est accessible en écriture.
273
+
268
274
  ## API GitHub
269
275
 
270
276
  ### E3001 : Création de release échouée
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ferrflow/doc",
3
- "version": "7.26.13",
3
+ "version": "7.27.1",
4
4
  "description": "Documentation for FerrFlow, the universal semantic versioning CLI. Rendered at ferrflow.com/docs.",
5
5
  "license": "MIT",
6
6
  "repository": {