Skip to content

docs: Add and update docs for the 4.0 release#228

Merged
acoulton merged 7 commits into
Behat:v4.xfrom
acoulton:4.x-docs
Jun 22, 2026
Merged

docs: Add and update docs for the 4.0 release#228
acoulton merged 7 commits into
Behat:v4.xfrom
acoulton:4.x-docs

Conversation

@acoulton

@acoulton acoulton commented Jun 21, 2026

Copy link
Copy Markdown
Contributor

Removes details of YAML configuration and PHPDoc annotations, which we no longer support.

Provides update notes for Behat 4.0 - I have focused on spelling out the steps for end users to follow, and the most significant changes that we expect will affect all extension authors. There are other changes that might affect a minority of extensions but I think it's OK to point to the CHANGELOG for these. We can always add more guidance later if we see people having common issues.

I've also only given brief details about using Rector and links to their own documentation. I don't think we need to repeat that in our own docs, and it avoids us getting out of sync with any changes in Rector.

Also documents our approach to Backwards Compatibility, following the PHPStan conventions, as discussed in Behat/Behat#1745 and applied in Behat/Behat#1807.

Explain what is (and is not) guaranteed to be backwards compatible
between minor and patch releases.
@acoulton acoulton changed the title docs: Document our backwards compatibility policy docs: Add and update docs for the 4.0 release Jun 21, 2026
@acoulton acoulton marked this pull request as draft June 21, 2026 22:49
acoulton added 2 commits June 22, 2026 10:17
Remove references to YAML config and update Extensions example
to show referencing the extension by its fully-qualified class name.
Simplify some wording, make it friendlier, improve clarity of the lists of actions.
Simplify some wording, make it friendlier, improve clarity of the lists of actions.
@acoulton

Copy link
Copy Markdown
Contributor Author

Comment thread releases/upgrading-to-4.0.rst Outdated
6. **Check Deprecations:** Run your tests with ``--fail-on-deprecations`` and fix any warnings that appear.
7. **Test the New Parser:** Enable the :doc:`GHERKIN_32 parser mode </user_guide/gherkin/parser_mode>` and see if your
tests still run correctly. If you have issues, you can fix your feature files or use
``GherkinCompatibilityMode::LEGACY`` in your config. This mode will be removed in future.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"in the future"

@carlos-granados carlos-granados left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Outstanding work, @acoulton, just a single tiny comment, no need to ask for a new review when you fix it

@acoulton acoulton marked this pull request as ready for review June 22, 2026 21:05
@acoulton acoulton merged commit ec680d0 into Behat:v4.x Jun 22, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants