Skip to content
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.

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

PHP Config - Suites #179

Merged
merged 2 commits into from
Dec 9, 2024
Merged

Conversation

loic425
Copy link
Contributor

@loic425 loic425 commented Dec 4, 2024

With the current state of Behat/Behat#1539

I think we need to create a specific branch "3.17".

Overview here https://behat--179.org.readthedocs.build/en/179/user_guide/configuration/suites.html#suite-paths

The filters implementation is still on PR review.

@carlos-granados
Copy link
Contributor

@loic425 what is the plan, to show both yaml and php configuration? Not sure if we should just show php configuration and then mention somewhere that you can also use yaml with some examples, the same way that I am doing with attributes and annotations in this PR #178

@stof
Copy link
Member

stof commented Dec 4, 2024

I don't think we want to maintain separate versions of the documentation for each minor version (especially given that older minor versions don't receive updates according to our versioning policy). It is unfortunate that the documentation branch is named 3.0 and not 3.x but renaming it would break all links (unless we configure RTD to redirect that version)

@loic425 loic425 marked this pull request as ready for review December 5, 2024 08:27
@loic425
Copy link
Contributor Author

loic425 commented Dec 5, 2024

@acoulton I've updated this PR with last changes.

Copy link
Contributor

@acoulton acoulton left a comment

Choose a reason for hiding this comment

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

This is looking good to me.

I agree with the others that we should only have one branch per major-version-series in the docs, and that we should just migrate the docs examples from yaml to PHP rather than showing both.

I'd suggest we add one single page for the YAML config that just shows a single example of a complete YAML file with all available options, perhaps with comments to mark which PHP config objects they equate to?

Copy link
Contributor

@acoulton acoulton left a comment

Choose a reason for hiding this comment

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

Looks great, thanks @loic425 - I've just rebased it to pick up an unrelated linting issue that was fixed in 3.0 since you opened this.

Copy link
Contributor

@carlos-granados carlos-granados left a comment

Choose a reason for hiding this comment

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

Thanks @loic425

@carlos-granados carlos-granados merged commit fd57ec8 into Behat:v3.0 Dec 9, 2024
4 checks passed
@loic425 loic425 deleted the php-config/suites branch December 9, 2024 16:49
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.

4 participants