ferrflow

ferrflow release

Run the full release pipeline: bump versions, update changelogs, commit, tag, push, and create a release.

ferrflow release [OPTIONS]
Flag Description
--dry-run Preview all changes without writing, committing, or pushing
--verbose, -v Show detailed output including commit hashes and file diffs

What it does:

  1. Scans commits since the last tag for each package
  2. Determines the version bump from Conventional Commits
  3. Updates all versionedFiles with the new version
  4. Appends the new section to CHANGELOG.md
  5. Creates a git commit with the version bump changes
  6. Creates and pushes the git tag
  7. Creates a GitHub/GitLab release with the changelog as notes

ferrflow check

Preview what ferrflow release would do without making any changes. Equivalent to ferrflow release --dry-run.

ferrflow check

ferrflow changelog

Generate or update CHANGELOG.md only, without bumping versions or creating tags.

ferrflow changelog [OPTIONS]
Flag Description
--dry-run Print the changelog entry without writing to disk

ferrflow init

Scaffold a config file for the current repository. Detects existing version files (Cargo.toml, package.json, etc.) and generates the appropriate config.

ferrflow init [OPTIONS]
Flag Description
--format Config file format: json, json5, or toml

ferrflow status

Show the current version of each package and whether a release would be triggered.

ferrflow status [OPTIONS]
Flag Description
--output Output format: text (default) or json

Example output:

api    1.2.3   minor bump pending (1 feat commit)
site   0.4.1   no release (only chore commits)

ferrflow version

Print the current version of one or all packages. Useful in CI scripts.

ferrflow version [PACKAGE] [OPTIONS]
Flag Description
--json Output as JSON

Returns the version from the latest git tag matching the package's tag template.

ferrflow tag

Print the latest tag for one or all packages.

ferrflow tag [PACKAGE] [OPTIONS]
Flag Description
--json Output as JSON

Global flags

These flags work with all commands:

Flag Description
--config Path to a custom config file (default: auto-detected). Also accepts FERRFLOW_CONFIG env variable.
--version Print the FerrFlow version and exit
--help, -h Print help