Added a deprecation notice and migration path to the Behat core progress formatter.

[AlexSkrypnyk]

Summary

Behat's built-in progress formatter just picked up an inline_failures option, which is the same behavior this package has provided since day one. This adds a deprecation warning to the top of the README and a new "Migrating to Behat core" section that walks through the switch, since the reason this extension existed is now available upstream.

Changes

• Added a [!WARNING] banner above the intro that flags the package as deprecated, notes the support window through 31 December 2026, links to the upstream Behat issue that prompted the feature, and points to the migration section.
• Added a "Migrating to Behat core" section with the behat.yml config and command-line equivalent for enabling inline_failures on core's progress formatter, plus the composer remove step to drop this package.
• Noted that show_output keeps the same four values (yes, no, on-fail, in-summary) in core, so that part of a behat.yml carries over unchanged.
• Called out that inline_failures is merged into Behat's 3.x branch but hasn't shipped in a tagged release yet (v3.32.0 is still the latest), so migration has to wait for the next release.

Before / After

README structure
┌─────────────────────────────┐        ┌─────────────────────────────┐
│ Before                      │        │ After                       │
├─────────────────────────────┤        ├─────────────────────────────┤
│ badges                      │        │ badges                      │
│ intro                       │        │ ⚠ WARNING: deprecated,      │
│ ...                         │        │   supported until           │
│ ## Configuration            │        │   31 Dec 2026                │
│ ## Maintenance              │        │ intro                       │
│                             │        │ ...                         │
│                             │        │ ## Configuration            │
│                             │        │ ## Migrating to Behat core  │
│                             │        │ ## Maintenance              │
└─────────────────────────────┘        └─────────────────────────────┘
  No signal the package is               Warning up top, migration
  going away or how to leave it.         path spelled out below.

behat.yml
┌─────────────────────────────┐        ┌─────────────────────────────┐
│ formatters:                 │        │ formatters:                 │
│   progress_fail:            │        │   progress:                 │
│     show_output: yes        │        │     inline_failures: true   │
│                             │        │     show_output: yes        │
└─────────────────────────────┘        └─────────────────────────────┘
  drevops/behat-format-progress-fail     core Behat only, no extra
  required in composer.json              dependency

Summary by CodeRabbit

• Documentation
  • Marked the package as deprecated, with support ending on 31 December 2026.
  • Added migration guidance for using Behat’s built-in progress formatter with inline failures.
  • Included configuration and command-line examples, plus release availability guidance.

[coderabbitai]

📝 Walkthrough

Walkthrough

README.md marks the extension deprecated through 31 December 2026 and documents migration to Behat core’s progress formatter using inline_failures: true.

Changes

Deprecation and migration

Layer / File(s)	Summary
Deprecation notice and Behat core migration README.md	Adds the deprecation deadline and documents equivalent behat.yml and CLI configuration, show_output compatibility, and inline_failures release timing.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related issues

• drevops/behat-format-progress-fail#85 — The README updates document the decommissioning plan, 31 December 2026 deadline, and migration to Behat’s inline_failures option.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main change: adding a deprecation notice and migration guidance for the Behat core formatter.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feature/deprecation-notice

---

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 90: Insert a blank line immediately before the fenced YAML block in the
README section shown, ensuring the opening fence is separated from preceding
content to satisfy markdownlint MD031.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: d2de0ba1-0dda-4830-bb27-873b9dc58ffc

📥 Commits

Reviewing files that changed from the base of the PR and between 958da0a and 7df06f0.

📒 Files selected for processing (1)

• README.md

[coderabbitai]

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Add a blank line before the fenced block.

This is reported by markdownlint as MD031 and may fail documentation checks.

Proposed fix

 >behat.yml
+
 ```yaml

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	```yaml
	>behat.yml

🧰 Tools

🪛 markdownlint-cli2 (0.23.0)

[warning] 90-90: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 90, Insert a blank line immediately before the fenced YAML
block in the README section shown, ensuring the opening fence is separated from
preceding content to satisfy markdownlint MD031.

Source: Linters/SAST tools