@ferrflow/darwin-x64 2.19.2 → 2.19.3

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.
Files changed (3) hide show
  1. package/README.md +131 -0
  2. package/bin/ferrflow +0 -0
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -31,6 +31,11 @@ Most versioning tools are tied to a specific ecosystem (semantic-release for JS,
31
31
  | TOML | `pyproject.toml` | Python |
32
32
  | JSON | `package.json` | Node.js |
33
33
  | XML | `pom.xml` | Java / Maven |
34
+ | CSProj | `*.csproj` | .NET (C#, F#) |
35
+ | Gradle | `build.gradle` | Java / Kotlin |
36
+ | Helm | `Chart.yaml` | Kubernetes / Helm |
37
+ | Go | `go.mod` | Go (tag-only, no file write) |
38
+ | Text | `VERSION`, `VERSION.txt` | Any |
34
39
 
35
40
  ## Installation
36
41
 
@@ -343,6 +348,132 @@ Branch names support glob patterns. The first match wins.
343
348
  - Stable releases include all commits since the last stable tag (skipping pre-release tags)
344
349
  - Hook environment includes `FERRFLOW_CHANNEL` and `FERRFLOW_IS_PRERELEASE`
345
350
 
351
+ ## Release Commit Mode
352
+
353
+ Controls how FerrFlow commits version bumps and changelog updates after a release.
354
+
355
+ ```toml
356
+ [workspace]
357
+ release_commit_mode = "commit" # default
358
+ ```
359
+
360
+ | Mode | Description |
361
+ |------|-------------|
362
+ | `commit` | Push a release commit directly to the branch |
363
+ | `pr` | Create a pull request with the release changes |
364
+ | `none` | Skip committing entirely (useful when another tool handles it) |
365
+
366
+ When using `pr` mode, `auto_merge_releases` controls whether the PR is automatically merged:
367
+
368
+ ```toml
369
+ [workspace]
370
+ release_commit_mode = "pr"
371
+ auto_merge_releases = true # default
372
+ ```
373
+
374
+ ### Skip CI
375
+
376
+ By default, release commits in `commit` mode include `[skip ci]` in the message to avoid triggering a CI loop. Override with `skip_ci`:
377
+
378
+ ```toml
379
+ [workspace]
380
+ skip_ci = false # force CI to run on release commits
381
+ ```
382
+
383
+ In `pr` mode, `skip_ci` defaults to `false` since the PR merge triggers CI naturally.
384
+
385
+ ## Floating Tags
386
+
387
+ Move abbreviated tags (e.g. `v1`, `v1.2`) to always point at the latest matching release:
388
+
389
+ ```toml
390
+ [workspace]
391
+ floating_tags = ["major"] # creates/moves v1 when releasing v1.2.3
392
+ ```
393
+
394
+ | Level | Tag | Points to |
395
+ |-------|-----|-----------|
396
+ | `major` | `v1` | Latest `v1.x.x` |
397
+ | `minor` | `v1.2` | Latest `v1.2.x` |
398
+
399
+ Floating tags are never moved by pre-release versions. Override per package:
400
+
401
+ ```toml
402
+ [[package]]
403
+ name = "api"
404
+ path = "packages/api"
405
+ floating_tags = ["major", "minor"]
406
+ ```
407
+
408
+ ## Orphaned Tag Strategy
409
+
410
+ After a rebase + force-push, existing tags may point to commits that no longer exist on the branch. `orphaned_tag_strategy` controls how FerrFlow handles this:
411
+
412
+ ```toml
413
+ [workspace]
414
+ orphaned_tag_strategy = "warn" # default
415
+ ```
416
+
417
+ | Strategy | Description |
418
+ |----------|-------------|
419
+ | `warn` | Log a warning and skip the orphaned tag |
420
+ | `treeHash` | Attempt recovery by matching the commit's tree hash |
421
+ | `message` | Attempt recovery by matching the commit message |
422
+
423
+ ## Recover Missed Releases
424
+
425
+ In monorepos, a package can miss a release if its files changed but FerrFlow wasn't run. Enable `recover_missed_releases` to compare files against the last tag instead of just the last commit:
426
+
427
+ ```toml
428
+ [workspace]
429
+ recover_missed_releases = true # default: false
430
+ ```
431
+
432
+ ## Package Dependencies
433
+
434
+ In a monorepo, use `depends_on` to automatically patch-bump a package when one of its dependencies is released:
435
+
436
+ ```json
437
+ {
438
+ "package": [
439
+ { "name": "core", "path": "packages/core" },
440
+ {
441
+ "name": "cli",
442
+ "path": "packages/cli",
443
+ "depends_on": ["core"]
444
+ }
445
+ ]
446
+ }
447
+ ```
448
+
449
+ When `core` is bumped, `cli` gets a patch bump even if it had no direct commits.
450
+
451
+ ## Hooks
452
+
453
+ Run shell commands at lifecycle points during a release. Hooks can be set at the workspace level (applies to all packages) or per package:
454
+
455
+ ```toml
456
+ [workspace.hooks]
457
+ pre_bump = "echo 'about to bump'"
458
+ post_bump = "cargo check"
459
+ pre_commit = "npm run build"
460
+ pre_publish = "npm pack --dry-run"
461
+ post_publish = "notify-slack.sh"
462
+ on_failure = "abort" # or "continue"
463
+ ```
464
+
465
+ | Hook | When |
466
+ |------|------|
467
+ | `pre_bump` | After bump calculation, before writing version files |
468
+ | `post_bump` | After writing version files, before changelog generation |
469
+ | `pre_commit` | After changelog generation, before git commit |
470
+ | `pre_publish` | After commit and tag, before push |
471
+ | `post_publish` | After push and release creation |
472
+
473
+ If a hook exits non-zero and `on_failure` is `abort` (default), the release is cancelled. Set `on_failure` to `continue` to ignore hook failures.
474
+
475
+ Hook commands receive environment variables: `FERRFLOW_PACKAGE`, `FERRFLOW_VERSION`, `FERRFLOW_PREV_VERSION`, `FERRFLOW_CHANNEL`, `FERRFLOW_IS_PRERELEASE`.
476
+
346
477
  ## Conventional Commits
347
478
 
348
479
  FerrFlow follows the [Conventional Commits](https://www.conventionalcommits.org/) spec.
package/bin/ferrflow CHANGED
Binary file
package/package.json CHANGED
@@ -12,5 +12,5 @@
12
12
  "type": "git",
13
13
  "url": "git+https://github.com/FerrFlow-Org/FerrFlow.git"
14
14
  },
15
- "version": "2.19.2"
15
+ "version": "2.19.3"
16
16
  }