Skip to content

Changelog

The project changelog is also maintained in CHANGELOG.md at the repository root.

Unreleased

[1.4.1] - 2026-11-18

Fixed

  • Fixed --timeout being forwarded as a native behave flag (unsupported in behave 1.3.x); it is now enforced at the subprocess layer.
  • Fixed run() mutating os.environ; subprocesses now receive a copied env.
  • Fixed missing warnings for --parallel/--parallel-scheme without behave-pool, --retry without behave-retry, --priority without behave-priority, and absent report formatter packages.
  • Fixed RunConfig accepting invalid shard values.
  • Fixed resolve_executable missing user-site console scripts (%APPDATA%\Python\PythonXY\Scripts, ~/.local/bin).
  • Fixed external-tool "not found" messages to distinguish a missing package from an importable package with a missing console script.
  • Fixed collect_scenarios rejecting str paths and duplicating scenarios reachable through overlapping paths.
  • Fixed load_config/config not finding pyproject.toml from subdirectories.
  • Fixed load_config crashing on non-UTF-8 pyproject.toml and silently ignoring unreadable behave.ini files.
  • Fixed find_latest_report crashing on OSError and reports being opened without a file:// URI.
  • Fixed config set/config init corrupting pyproject.toml around commented headers or a missing trailing newline.
  • Fixed impact --run failing with No steps directory under the conventional features/steps layout.
  • Fixed record/report generate crashing on unwritable output dirs.
  • Fixed watch failing on features given as a str and accepting negative --debounce/--poll.
  • Fixed the watcher looping forever on directory symlink cycles.
  • Fixed find_project_root with relative or file start paths.
  • Fixed diagnostics being printed to stdout instead of stderr in several commands.
  • Fixed is_installed executing module code; it now uses find_spec.
  • Fixed collect_scenarios missing Rule: scenarios and inherited tags; tag filters now support behave v2 expressions and file.feature:LINE.
  • Fixed timed-out runs leaving orphaned parallel workers; the timeout now kills the whole process tree.
  • Fixed behave.ini BOM handling, [DEFAULT] leakage, and profile-name case (profiles.CI now round-trips).
  • Fixed config set corrupting pyproject.toml on fake headers inside multiline strings or multiline array values; set/init warn when the active config lives in behave.ini.
  • Fixed watch deferring invalid merged config until the first change.
  • Fixed report generate launching behave for formats whose package is missing; report show/open now exit 1 when no report is found.
  • Fixed impact --run swallowing doctor's stderr and unparseable output.
  • Fixed --flaky-report being discarded when retries came from a profile.
  • Fixed the watcher scanning generated artifacts (reports/, .git/).
  • Fixed select/list crashing on non-UTF-8 consoles with emoji/CJK scenario names.

Changed

  • Relaxed the typer pin to <0.30 and added the Python 3.14 classifier.

[1.4.0] - 2026-10-05

Fixed

  • Fixed run and watch ignoring base [tool.behave-runner] values. Configuration now merges as documented: base table < profile < CLI flags.
  • Fixed --max-fail values above 1 silently mapping to --stop. Now emits a warning explaining that behave can only stop at the first failure.
  • Fixed --trace, --ui, and --debug being silently ignored when behave-trace is not installed. Now emits a warning.
  • Fixed config set writing bracket values like [@smoke, @fast] as plain strings; values now accept TOML syntax and unquoted bracket lists.
  • Fixed config set dropping trailing comments and mangling echoed values containing [brackets].
  • Fixed config set rejecting dotted keys when the matching subtable exists; the leaf is now written inside the subtable.
  • Fixed config showing a raw docstring as its help text.
  • Fixed open trace ignoring --output.
  • Fixed report generate writing nothing for non-console formats unless --output was given; reports now default to reports/.
  • Fixed behave.ini being read with the platform locale instead of UTF-8.
  • Fixed external tool calls failing when the package was importable but its console script was not on PATH; scripts are now resolved next to sys.executable first.
  • Fixed list/select silently ignoring nonexistent feature paths.

Changed

  • Version is now defined once in behave_runner/__init__.py and read dynamically by hatch.
  • Renamed _normalize_profile to _normalize_values.
  • Fixed documentation inaccuracies in the FAQ, watch/report/config command pages, ecosystem page, and CI/CD page.

[1.3.0] - 2026-08-14

Fixed

  • Fixed configparser using default interpolation, which caused InterpolationSyntaxError when behave.ini values contained % characters. Now uses interpolation=None to read values literally.
  • Fixed RunConfig accepting empty strings for parallel_scheme, parallel_balance, and parallel_timing_file fields.
  • Fixed _normalize_list not filtering empty strings from list input (only filtered from comma-separated string input).
  • Fixed watch.py using empty list as default features when profile features list was empty, instead of falling back to ["features"] like run.py.
  • Fixed collect_scenarios not filtering empty strings from include and exclude tags, causing empty tag filters to exclude all scenarios.
  • Fixed impact.py not escaping regex special characters in scenario names before passing them to behave's --name option.
  • Re-added utils.py to docs/architecture.md core modules table and docs/python-api.md mkdocstrings reference (was incorrectly removed in a prior commit — the file exists and is used by core/output.py).
  • Added missing parallel_scheme, parallel_balance, and parallel_timing_file keys to docs/configuration.md configuration table and merge scope note.
  • Fixed docs/commands/run.md description to accurately reflect that the orchestrator builds a single behave command and executes it via subprocess.run, rather than dispatching to separate runner paths.
  • Fixed broken behave-modern-file-report GitHub URL (plural → singular) in README, docs/ecosystem.md, and docs/installation.md.
  • Fixed README and docs/ecosystem.md listing "core" as an installable extra for behave, behave-kit, and behave-model. Changed to "included" since these are installed automatically with the base package.
  • Fixed docs/index.md features list missing init, record, and open commands.
  • Fixed README Requirements section incorrectly stating ecosystem packages are installed as optional extras (core deps are installed automatically).
  • Added Changelog link to README Links section.
  • Updated LICENSE copyright year to 2025-2026.
  • Updated bug report template version placeholder from 0.1.0 to 1.2.0.
  • Removed placeholder FUNDING.yml (all content was commented out).
  • Added .pre-commit-config.yaml to sdist include list.
  • Fixed test_steps_no_args_shows_help and test_trace_no_args_shows_help tests expecting non-zero exit code when Typer's no_args_is_help=True correctly exits with 0.
  • Fixed docs/ecosystem.md intro stating "six categories" when the table actually has nine (core, execution, debug, quality, scaffolding, steps, utility, recording, reporting).
  • Fixed 5 purpose text inconsistencies between README and docs/ecosystem.md quick reference tables (behave-comments, behave-doctor, behave-modern-console-report, behave-priority, behave-retry).
  • Fixed README ecosystem table using "Scaffold" instead of "Scaffolding" for the behave-gen category.
  • Fixed .github/workflows/ci.yml pip-audit missing --strict flag, inconsistent with the Makefile security target and docs/ci-cd.md CI template.
  • Fixed docs/ecosystem.md claiming behave-tables is "bundled with the core installation" when it is not a dependency of behave-runner.

Changed

  • Extracted shared validate_shard function to orchestrator.py to eliminate duplicated shard validation logic between run.py and watch.py.
  • Moved inline imports (importlib, warnings, load_profile, ConfigError) to module level in orchestrator.py and watch.py.
  • Added __all__ to behave_runner/__init__.py to explicitly declare the public API.
  • Fixed misleading _normalize_profile docstring that referenced only INI config when it handles both INI and TOML values.
  • Added features.py to docs/python-api.md API reference.
  • Synced docs/changelog.md with CHANGELOG.md (was missing [1.2.0] section).

[1.2.0] - 2026-08-13

Fixed

  • Fixed formatter resolution in orchestrator.py: changed _REPORT_FORMATTERS from entry point names to scoped names (module:Class) so behave 1.2.6 can resolve them via load_formatter_class().
  • Fixed --parallel being passed to behave without checking if behave-pool is functionally installed. Added _is_package_functional() helper that verifies a package has real .py files, not just an empty namespace.
  • Fixed --runner behave_pool being passed to behave (not a valid CLI flag).
  • Fixed --shard being passed as a CLI flag instead of only via BEHAVE_POOL_SHARD environment variable.
  • Fixed regression tests failing on Windows due to cross-drive os.path.relpath errors by mocking orchestrator.run and using monkeypatch.chdir.

Added

  • Added comprehensive behave project fixture (tests/fixtures/full/) with 3 features, 10 scenarios, tags, hooks, and intentional failures.
  • Added integration tests for select command with full fixture (11 tests).
  • Added integration tests for steps command (13 tests).
  • Added integration tests for trace command (7 tests).
  • Added integration tests for watch command (3 tests).
  • Added unit tests for FileWatcher (5 tests: deleted files, nested dirs, run loop, callback, debounce).
  • Added integration tests for run command with real execution (12 tests).

Changed

  • Updated .gitignore to cover generated reports and build artifacts.

[1.1.0] - 2026-08-07

Fixed

  • Fixed load_config not falling back to behave.ini when pyproject.toml exists but lacks [tool.behave-runner] section.
  • Fixed _format_value not escaping double quotes and backslashes in TOML string values, which could produce invalid TOML.
  • Fixed run.py only loading 4 config values from profiles. Now loads all supported values: parallel, retries, dry_run, stop_on_failure, scenario_timeout, priority_order, fail_fast, flaky_report, max_failures.
  • Fixed report.py not supporting "file" format even though behave-modern-file-report is listed as an optional extra.
  • Fixed orchestrator.py not passing environment variables to subprocess fallback paths.
  • Fixed README CLI option names and watch command quit instructions.
  • Translated mkdocs.yml site description and docs/index.md to English.
  • Fixed docs/index.md incorrect examples and non-existent config keys.
  • Updated pyproject.toml development status from Alpha to Production/Stable.
  • Fixed .pre-commit-config.yaml mypy hook missing project dependencies.
  • Added SECURITY.md.
  • Improved orchestrator.py by reducing duplicated subprocess fallback code.
  • Improved output.py symlink safety in clean_output_dir.
  • Improved watcher.py error handling to log instead of silently suppressing.
  • Added TypedDict for scenario info in features.py.
  • Added regression tests for all bug fixes.
  • Fixed config_cmd.py exit code for missing pyproject.toml (1 → 2).
  • Fixed all Spanish text in docs command reference.
  • Fixed docs/cli.md report format names (xlsx → sheets, pdf → file).
  • Fixed docs/cli.md --smoke flag incorrectly listed as requiring behave-priority.
  • Fixed docs/commands/report.md format names and added "file" to format list.
  • Fixed docs/commands/run.md --smoke dependency listing.
  • Fixed docs/commands/init.md positional arg example to use --name flag.
  • Fixed docs/quickstart.md init example to use --name flag.
  • Fixed docs/index.md init example and report format example.
  • Fixed docs/configuration.md fallback and merge scope descriptions.
  • Fixed docs/installation.md and docs/ecosystem.md priority extra description.
  • Added sdist build target to pyproject.toml to include tests and docs.
  • Refactored orchestrator.py to eliminate duplicated subprocess fallback code via _try_optional and _run_behave_subprocess helpers.
  • Added Codecov badge to README.
  • Added Dependabot configuration for pip and GitHub Actions.
  • Upgraded codecov-action to v5 in CI workflow.
  • Simplified CI pip caching to use setup-python built-in cache.
  • Added SECURITY.md to sdist include list.
  • Added Requirements and Acknowledgements sections to README.
  • Added bandit and pip-audit to dev dependencies for security scanning.
  • Added Framework :: Pytest classifier to pyproject.toml.
  • Added security job to CI workflow (bandit + pip-audit).
  • Added GitHub funding configuration file.
  • Added bandit configuration to pyproject.toml.
  • Added make security target to Makefile.
  • Fixed docs/ecosystem.md library count (22 → 21).
  • Fixed docs/configuration.md incorrect behave.ini profile example.
  • Updated docs/ci-cd.md to reflect codecov-action v5.
  • Fixed config.py load_config crashing with AttributeError if [tool] is not a dictionary in pyproject.toml.
  • Fixed config.py load_config not catching UnicodeDecodeError from configparser for non-decodable behave.ini files.
  • Fixed output.py clean_output_dir crashing on OSError from iterdir().
  • Fixed run.py flaky_report check not accounting for profile-defined retries.
  • Fixed run.py profile max_fail key being silently ignored.
  • Fixed run.py profile smoke key being silently ignored.
  • Fixed config_cmd.py _set_config_value corrupting TOML when setting dotted keys that conflict with existing subtables.
  • Fixed config_cmd.py config set not catching ConfigError.
  • Fixed orchestrator.py RunConfig.parallel=0 being allowed but silently falling back to sequential execution.
  • Fixed features.py feature.name and scenario.name being None crashing with AttributeError / TypeError.
  • Fixed features.py ScenarioInfo TypedDict contract being violated when names are None.
  • Fixed watch.py negative --debounce causing the watcher to never trigger.
  • Fixed output.py ensure_output_dir crashing if path exists as a file.
  • Fixed orchestrator.py _try_optional not catching non-ImportError exceptions from optional dependencies.
  • Fixed config.py _ini_flat_to_nested silently overwriting leaf values with dicts on key conflicts.
  • Fixed Makefile test and test-cov targets not excluding e2e tests.
  • Fixed .github/workflows/ci.yml bandit and pip-audit not declared as dev dependencies.
  • Fixed orchestrator.py run() saving/restoring all environment variables instead of only behave-specific ones.
  • Fixed output.py race condition in find_latest_report when calling stat().
  • Fixed select.py and list_cmd.py lacking validation for the fmt argument.
  • Fixed config_cmd.py _parse_value not stripping whitespace from string values.
  • Fixed run.py shard values from profiles not being type-validated.

Added

  • AGENTS.md with project-specific conventions and verification steps.
  • behave_runner/core/features.py with collect_scenarios and matches_tags utilities extracted from select.py and list_cmd.py.
  • Comprehensive regression test suite (tests/unit/test_regression.py).

[1.0.1] - 2026-08-07

  • Updated README and package description to English.
  • Added repository topics on GitHub.
  • No functional changes.

[1.0.0] - 2026-08-07

  • Stable release of behave-runner.
  • All 16 CLI commands implemented and documented.
  • MkDocs documentation site with architecture, ecosystem, Python API, CI/CD and FAQ pages.
  • Community files and README.
  • Fixed CI coverage threshold for environments without optional extras.
  • Fixed cross-platform find_project_root test.
  • Added BEHAVE_RUNNER_NO_BROWSER to prevent browser opening during tests.

[0.1.0] - 2026-07-08

  • Initial release of behave-runner CLI.
  • Commands: run, list, select, lint, format, doctor, impact, watch, report, trace, steps, generate, init, config, open, record.
  • E2E test fixtures for saucedemo.com and pokeapi.co.
  • CI workflow with matrix testing across Python 3.11-3.14.
  • MkDocs Material documentation site.
  • Community files: CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, SUPPORT.md, issue and pull request templates.