@ferrflow/doc 7.29.0 → 7.30.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.
- 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 +683 -683
- package/docs-en/reference/cli.md +2 -0
- package/docs-fr/reference/cli.md +2 -0
- package/package.json +1 -1
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'FerrFlow: a hotfix no longer drags a floating tag backward'
|
|
3
|
+
summary: 'Releasing 1.4.2 after 1.5.0 silently moved v1 back to 1.4.2. The guard meant to stop that never fired. It does now: the release stops before anything is pushed, and --force lets the alias move.'
|
|
4
|
+
date: 2026-09-28T10:00:00Z
|
|
5
|
+
product: ferrflow
|
|
6
|
+
type: fix
|
|
7
|
+
prLink: https://github.com/FerrLabs/FerrFlow/pull/1226
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
Floating tags such as `v1` or `v1.5` are supposed to only move forward: when a release on an older line would point them at a lower version, FerrFlow stops the release, and only `--force` lets the alias move backward, with a warning. That check read the version from the alias tag's message, which git hands back with a trailing newline, so parsing it failed and the check concluded there was nothing to protect.
|
|
11
|
+
|
|
12
|
+
In practice, cutting a hotfix on a maintenance branch moved the major alias back to the hotfix, and anyone pinned to `v1` got the older code. The check now works as documented, which changes what a hotfix pipeline sees: a job that used to succeed on a maintenance line now fails at `ferrflow release` with "Floating tag v1 would move backward", before anything is pushed. If you do want the alias to follow the hotfix, add `--force` to that job.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'FerrFlow: the Helm publisher reads the right chart name'
|
|
3
|
+
summary: 'In a Chart.yaml listing dependencies or maintainers before the chart name, the Helm publisher could take a dependency name for the chart and check or push the wrong reference. Only the top-level name key counts now.'
|
|
4
|
+
date: 2026-09-28T10:10:00Z
|
|
5
|
+
product: ferrflow
|
|
6
|
+
type: fix
|
|
7
|
+
prLink: https://github.com/FerrLabs/FerrFlow/pull/1231
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
The `helm` publisher reads the chart name from `Chart.yaml` to build the OCI reference it checks and pushes. It matched the first `name:` on any line, indented or not, so a chart whose `dependencies:` or `maintainers:` block came before its own `name:` was treated as the dependency: the "already published" check looked at the wrong reference, and the push went there too.
|
|
11
|
+
|
|
12
|
+
The publisher now only reads the top-level `name:` key, whatever order the file is written in. Charts that put `name:` first were never affected.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'FerrFlow: migrating from semantic-release keeps your tags'
|
|
3
|
+
summary: 'ferrflow migrate turned tagFormat "v${version}" into tagTemplate "v{{version}}", which FerrFlow renders as v{1.2.0}. It now writes "v{version}", so the migrated config finds the tags semantic-release created.'
|
|
4
|
+
date: 2026-09-28T10:05:00Z
|
|
5
|
+
product: ferrflow
|
|
6
|
+
type: fix
|
|
7
|
+
prLink: https://github.com/FerrLabs/FerrFlow/pull/1229
|
|
8
|
+
docsLink: https://ferrflow.com/docs/reference/cli
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
`ferrflow migrate` converts a semantic-release `tagFormat` into a FerrFlow `tagTemplate`. The conversion wrote the placeholder with doubled braces, `{{version}}`, while FerrFlow templates use single ones. A config migrated from `tagFormat: "v${version}"` therefore rendered tags like `v{1.2.0}`: the first release after migrating found none of the existing tags and started over.
|
|
12
|
+
|
|
13
|
+
The conversion now writes `{version}`. If you already migrated, check the `ferrflow.json` it wrote for `{{version}}` and replace it with `{version}`:
|
|
14
|
+
|
|
15
|
+
```json
|
|
16
|
+
{
|
|
17
|
+
"workspace": {
|
|
18
|
+
"tagTemplate": "v{version}"
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
The migration table in the CLI reference and in the entry that announced `ferrflow migrate` showed the same wrong output and have been corrected.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'FerrFlow: versions read from files never carry stray whitespace'
|
|
3
|
+
summary: 'A version written with padding or a line break inside its quotes came back with the whitespace attached and could not become a tag. package.json, Cargo.toml, pyproject.toml and Chart.yaml read with the helm format now trim it; mix.exs, gemspec, Gradle and Package.swift reject it with a clear error.'
|
|
4
|
+
date: 2026-09-28T10:15:00Z
|
|
5
|
+
product: ferrflow
|
|
6
|
+
type: fix
|
|
7
|
+
prLink: https://github.com/FerrLabs/FerrFlow/pull/1218
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
Several version file readers returned the quoted value exactly as written. `"version": " 1.2.0 "` in `package.json`, or a `version:` literal in `mix.exs` that spanned a line break, produced a version with whitespace in it, and the release then failed at `git tag` with an error about invalid ref names.
|
|
11
|
+
|
|
12
|
+
Where the version sits in a delimited string (`package.json`, `Cargo.toml`, `pyproject.toml`, and `Chart.yaml` read with the `helm` format that `ferrflow init` detects), the padding is unambiguous and is now trimmed, so those files keep working. Where the version is found by pattern (`mix.exs`, `.gemspec`, Gradle, `Package.swift`), a padded literal is now reported as "no version found" instead of being guessed at, so you can fix the file before anything is tagged.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'FerrFlow: rehearse a release with shadow-release'
|
|
3
|
+
summary: 'ferrflow shadow-release runs the real release pipeline in a throwaway clone, hooks included, and stops before anything is pushed or published. Use it to check that a release would go through before running it.'
|
|
4
|
+
date: 2026-10-02T16:30:00Z
|
|
5
|
+
product: ferrflow
|
|
6
|
+
type: new
|
|
7
|
+
prLink: https://github.com/FerrLabs/FerrFlow/pull/1256
|
|
8
|
+
docsLink: https://ferrflow.com/docs/reference/cli/
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
`--dry-run` shows what a release would change, but it stops short of the steps that can actually fail: writing the files, committing, tagging, running the hooks around them. `ferrflow shadow-release` runs those steps for real, in a temporary clone of your repository, so a broken hook or a file that will not bump shows up before the real release.
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
ferrflow shadow-release
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
The clone gets the versioned files, changelogs, release commit, tags and floating tags, and the pre-commit to pre-publish hooks run against it. Nothing is pushed, no forge release is created, and no publisher or post-publish hook runs. The command prints the commits, files and tags it produced, then deletes the clone. Pass `--keep` to inspect it instead. A failing step exits non-zero with its error code, so a CI job can run it as a gate.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'FerrFlow: a hotfix no longer moves the latest alias backward'
|
|
3
|
+
summary: 'With latestTag set, releasing 1.2.4 after 2.0.0 pointed latest at 1.2.4. latest now stays on the highest version; the hotfix release still goes through, and --force moves the alias back if you want it to.'
|
|
4
|
+
date: 2026-10-03T12:15:00Z
|
|
5
|
+
product: ferrflow
|
|
6
|
+
type: fix
|
|
7
|
+
prLink: https://github.com/FerrLabs/FerrFlow/pull/1262
|
|
8
|
+
docsLink: https://ferrflow.com/docs/configuration/config-file/
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
The `latestTag` alias followed whichever stable release ran last, so cutting a hotfix on a maintenance line pointed `latest` at an older version than the one most people should install. It now behaves like the floating `v1` and `v1.5` tags and never moves to a lower version on its own.
|
|
12
|
+
|
|
13
|
+
Unlike those tags, a backward `latest` does not stop the release: shipping a hotfix on an older line is a normal thing to do, so the release completes, `latest` stays put, and the output says `Kept latest on 2.0.0: 1.2.4 is older`. If you relied on `latest` meaning "most recently released", pass `--force` to that release and the alias moves back as before, with a warning.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'FerrFlow: release PRs are found again on branches with special characters'
|
|
3
|
+
summary: 'A target branch containing &, # or + broke the lookup for the existing release PR on GitHub and GitLab, so FerrFlow opened a second one. A failed branch update on GitHub also reported the wrong error.'
|
|
4
|
+
date: 2026-10-03T12:00:00Z
|
|
5
|
+
product: ferrflow
|
|
6
|
+
type: fix
|
|
7
|
+
prLink: https://github.com/FerrLabs/FerrFlow/pull/1261
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
With `releaseCommitMode: "pr"`, FerrFlow looks for an open release PR before proposing a new one. The branch name went into that query unencoded, so a branch such as `release/a+b` sent a different name to the API, the existing PR was not found, and a duplicate was opened. Branch names are now percent-encoded on both GitHub and GitLab.
|
|
11
|
+
|
|
12
|
+
On GitHub, moving the release branch fell back to creating it after any failure, so an expired token showed up as a confusing "create ref" error. FerrFlow now only creates the branch when GitHub says it does not exist, and otherwise reports the real failure under E3015.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'FerrFlow: a backtick in a version no longer breaks the PR preview table'
|
|
3
|
+
summary: 'The release preview comment wrapped versions in a code span that a backtick could close early, scrambling the table. Version cells now use a fence long enough for whatever they contain.'
|
|
4
|
+
date: 2026-10-03T12:05:00Z
|
|
5
|
+
product: ferrflow
|
|
6
|
+
type: fix
|
|
7
|
+
prLink: https://github.com/FerrLabs/FerrFlow/pull/1260
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
`ferrflow check --comment` posts a table of current and next versions on the pull request. Each version sat in a single-backtick code span, and the backslash used to escape a backtick inside it is ignored by Markdown, so a version containing a backtick closed the span and broke the row.
|
|
11
|
+
|
|
12
|
+
Version cells are now fenced with one more backtick than the longest run in the value, as CommonMark specifies, so the table renders the version exactly as written.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'FerrFlow: clearer wording in why and doctor'
|
|
3
|
+
summary: 'ferrflow why no longer prints "forced bump forced", and ferrflow doctor shows a declared strategy with its config spelling, such as calver-short instead of calvershort.'
|
|
4
|
+
date: 2026-10-03T12:10:00Z
|
|
5
|
+
product: ferrflow
|
|
6
|
+
type: fix
|
|
7
|
+
prLink: https://github.com/FerrLabs/FerrFlow/pull/1259
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
Two diagnostics printed text that did not match what you wrote. `ferrflow why` described a version pinned with `--force-version` as `Decision: forced bump forced`; it now reads `forced bump set with --force-version`. `ferrflow doctor` showed a declared versioning strategy with its hyphens dropped, so `calver-short` appeared as `calvershort`, a value the config would reject. It now prints the name exactly as you would write it in `ferrflow.json`.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'FerrFlow: JSON output names date and sequence strategies as you configure them'
|
|
3
|
+
summary: 'check --json and release --json reported bump_type as calvershortseq for a calver-short-seq package, and why --json did the same for strategy. They now use the configured spelling, such as calver-short-seq. Scripts matching the old value need updating.'
|
|
4
|
+
date: 2026-10-07T09:00:00Z
|
|
5
|
+
product: ferrflow
|
|
6
|
+
type: fix
|
|
7
|
+
prLink: https://github.com/FerrLabs/FerrFlow/pull/1293
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
For packages on a date or sequence strategy, the `bump_type` field of `ferrflow check --json` and `ferrflow release --json`, and the `strategy` field of `ferrflow why --json`, carried the strategy name with its hyphens dropped: `calvershort`, `calverseq`, `calvershortseq`. None of those is a value `ferrflow.json` accepts, and `ferrflow doctor` already printed the hyphenated form.
|
|
11
|
+
|
|
12
|
+
They now match the config: `calver-short`, `calver-seq`, `calver-short-seq`. `calver`, `sequential` and the semver bump types (`major`, `minor`, `patch`) are unchanged, and so is `FERRFLOW_BUMP_TYPE` in hooks. If a script compares `bump_type` or `strategy` against the old spelling, switch it to the hyphenated one.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'FerrFlow: hooks can no longer hang a release'
|
|
3
|
+
summary: 'Every hook now has a timeout, 15 minutes by default, after which FerrFlow kills it and everything it started. Hooks also run with stdin closed, so a command that would prompt fails at once instead of waiting forever.'
|
|
4
|
+
date: 2026-10-10T10:00:00Z
|
|
5
|
+
product: ferrflow
|
|
6
|
+
type: new
|
|
7
|
+
prLink: https://github.com/FerrLabs/FerrFlow/pull/1300
|
|
8
|
+
docsLink: https://ferrflow.com/docs/configuration/config-file/
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
A hook that never returned used to hold the release, and the release lock, until the CI job hit its own wall-clock limit. The usual causes are mundane: a command asking for a password on a terminal nobody is watching, a `curl` without a time limit, a test suite that deadlocks.
|
|
12
|
+
|
|
13
|
+
Hooks now run with stdin closed, which turns the prompting case into an immediate failure, and each hook gets a time limit. When it is reached, FerrFlow kills the hook along with any process it started in the background and treats it as a failed hook, so `onFailure` decides what happens next: `abort` stops the release, `continue` warns and carries on. A long hook prints that it is still running once a minute, which tells a slow build apart from a stuck one.
|
|
14
|
+
|
|
15
|
+
The default is 900 seconds. Raise or lower it for the workspace or for a single package:
|
|
16
|
+
|
|
17
|
+
```json
|
|
18
|
+
{
|
|
19
|
+
"workspace": {
|
|
20
|
+
"hooks": { "prePublish": "npm run build", "timeout": 1800 }
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
```
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'FerrFlow: init lists the packages of your workspace'
|
|
3
|
+
summary: 'ferrflow init now reads Cargo, Go and Gradle workspaces as well as npm and pnpm ones, and offers to scaffold one package per member instead of asking you to type them.'
|
|
4
|
+
date: 2026-10-10T15:00:00Z
|
|
5
|
+
product: ferrflow
|
|
6
|
+
type: new
|
|
7
|
+
docsLink: https://ferrflow.com/docs/reference/cli
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
Setting up a monorepo meant typing every package name, path and versioned file by hand, even though the workspace file already listed them. `ferrflow init` now reads that file and shows what it found before asking anything else.
|
|
11
|
+
|
|
12
|
+
It understands `workspaces` in `package.json` and `pnpm-workspace.yaml`, `[workspace] members` and `exclude` in `Cargo.toml`, `use` entries in `go.work`, and `include` calls in `settings.gradle` or `settings.gradle.kts`. Each member becomes a package with its manifest as the versioned file and a changelog beside it.
|
|
13
|
+
|
|
14
|
+
A Cargo workspace whose members use `version.workspace = true` is scaffolded as a single package at the root, since that is where the version lives.
|
|
15
|
+
|
|
16
|
+
Answer `n` to the prompt to fall back to entering packages by hand, as before.
|