Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlexSkrypnyk merged 1 commit into from
Jul 28, 2026
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@
[![Vortex Ecosystem](https://img.shields.io/badge/%F0%9F%8C%80-Vortex%20Ecosystem-2C5A68?style=for-the-badge&labelColor=65ACBC)](https://github.com/drevops/vortex)
</div>

> [!WARNING]
> **This package is deprecated.** It is supported until **31 December 2026**, after which it will be marked as abandoned and will receive no further releases, fixes, or compatibility updates.
>
> Behat now does this natively. The built-in `progress` formatter gained an `inline_failures` option that prints each failed, pending or undefined step as it happens, instead of holding everything back until the end-of-run summary. That is [exactly what this extension was built for](https://github.com/Behat/Behat/issues/1860), so it has served its purpose. Upgrade to the latest Behat and use the core formatter instead - see [Migrating to Behat core](#migrating-to-behat-core).

<p align="center">Behat output formatter to show progress as TAP and failures inline.
<br>
</p>
Expand Down Expand Up @@ -77,6 +82,35 @@ Show output from within test steps. "Output" is `print`, `echo`, `var_dump`, etc
- `on-fail` - only show the output if there are test fails
- `in-summary` - only show in the summary if there are test fails

## Migrating to Behat core

Upgrade Behat, remove this extension from your `behat.yml`, and enable the option on the built-in `progress` formatter instead:

>behat.yml
```yaml

@coderabbitai coderabbitai Bot Jul 28, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 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

default:
formatters:
progress:
inline_failures: true
show_output: in-summary
```

Or pass it on the command line:

```bash
vendor/bin/behat --format=progress --format-settings='{"inline_failures": true}'
```

`show_output` keeps the same four values in core that it has here (`yes`, `no`, `on-fail`, `in-summary`), so that part of your configuration carries over unchanged.

Then drop the dependency:

```bash
composer remove --dev drevops/behat-format-progress-fail
```

One caveat on timing: `inline_failures` is merged into Behat's `3.x` branch, but it has not been tagged in a stable release yet (the newest is `v3.32.0`). It will land in the next 3.x release. Until then, stay on this extension - that is what the support window through December 2026 is for.

## Maintenance

### Lint code
Expand Down