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

Declare conflict against nelmio/api-doc-bundle <2.13.5 || >=4.0 #1943

Merged
merged 1 commit into from
Mar 25, 2021

Conversation

phansys
Copy link
Member

@phansys phansys commented Mar 24, 2021

Subject

Declare conflict against nelmio/api-doc-bundle <2.13.5 || >=4.0.

I am targeting this branch, because this change respects BC.

Follow up of #1930.

Changelog

### Added
- Conflict against nelmio/api-doc-bundle <2.13.5 || >=4.0.

@phansys phansys added the minor label Mar 24, 2021
@phansys phansys requested a review from a team March 24, 2021 22:22
@phansys phansys marked this pull request as ready for review March 24, 2021 22:22
@phansys phansys closed this Mar 25, 2021
@phansys phansys reopened this Mar 25, 2021
@phansys
Copy link
Member Author

phansys commented Mar 25, 2021

Seems that the branch protection rules are referencing some non existing jobs.

@wbloszyk
Copy link
Member

Seems that the branch protection rules are referencing some non existing jobs.

https://github.com/sonata-project/SonataMediaBundle/pull/1944/files

@phansys phansys merged commit 26a2443 into sonata-project:3.x Mar 25, 2021
@phansys phansys deleted the nelmio_api_doc branch March 25, 2021 12:40
@Webonaute
Copy link

Why declaring conflict instead of fixing the conflict? it prevent from upgrading our project.

@VincentLanglet
Copy link
Member

Why declaring conflict instead of fixing the conflict? it prevent from upgrading our project.

Declaring the conflict is about telling the truth about the current situation to avoid people upgrading the nelmio api and getting stuck with a non working project.

Fixing the conflict

  • does not take the same time than adding the conflict
  • is maybe not possible without introducing BC-break.

Feel free to provide a PR ! :)

@wbloszyk
Copy link
Member

wbloszyk commented May 6, 2021

Why declaring conflict instead of fixing the conflict? it prevent from upgrading our project.

Diffrence between nelmio/api-doc-bundle v2, v3 and v4 are huge. Also they are using annotations which force us to provide solution for each version in seperate files. It will be hard to load with dotrine and contribiuting.

In Sonata4 we want to move API in seperate bundle(s). Then users will be ale to use Sonata solution, third part solution or PWN solution for provide API.

@VincentLanglet
Copy link
Member

Btw @phansys I'm not sure it works with the V3: #1958

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants