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

[TypeInfo] mark classes as experimental #54788

Merged
merged 1 commit into from
May 2, 2024

Conversation

soyuka
Copy link
Contributor

@soyuka soyuka commented Apr 30, 2024

Q A
Branch? 7.1
Bug fix? no
New feature? no
Deprecations? no
License MIT

This is following a discussion on slack with authors of the component, I feel that the TypeInfo component should have an experimental phase as we need to prove the component's functionality on software that is built on top of type information extraction. Here's a non-exhaustive list of software using the PropertyInfo Type class (thanks to @mtarld):

  • api-platform/core
  • nelmio/api-doc-bundle
  • typo3/cms-extbase
  • typo3/cms
  • sonata-project/page-bundle
  • jolicode/automapper
  • symfony/ux-live-component

These softwares should try their best in testing the new TypeInfo component and report back misfunctionalities and/or DX improvements before we can consider this non-experimental. See also #54789

@mtarld
Copy link
Contributor

mtarld commented Apr 30, 2024

I should mark the new getType methods as experimental as well, and remove the deprecations on getTypes (they've been introduced in #53160). Also, the README has to be updated

@xabbuh
Copy link
Member

xabbuh commented Apr 30, 2024

@mtarld see #54789

Copy link
Member

@nicolas-grekas nicolas-grekas left a comment

Choose a reason for hiding this comment

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

let's add "as experimental" to the changelog of the component also

Copy link
Member

@chalasr chalasr left a comment

Choose a reason for hiding this comment

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

Changelog update needed

@fabpot
Copy link
Member

fabpot commented May 2, 2024

Thank you @soyuka.

@fabpot fabpot merged commit 09e3c5c into symfony:7.1 May 2, 2024
4 of 10 checks passed
@fabpot
Copy link
Member

fabpot commented May 2, 2024

I've added a note in CHANGELOG and README.

fabpot added a commit that referenced this pull request May 2, 2024
…xperimental (soyuka)

This PR was merged into the 7.1 branch.

Discussion
----------

[PropertyInfo] remove deprecations, mark TypeInfo as experimental

| Q             | A
| ------------- | ---
| Branch?       | 7.1
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| License       | MIT

Follows #54788 as we can introduce these deprecation back when we feel the component is stable enough. Software like API Platform that heavily relies on the deprecated functionalities will have a really hard time migrating, we don't want to work more then needed and need to know we won't have to do the same work again in the next years.
This also suggest that PropertyInfo can work with or without the new TypeInfo component while it's being experimental.

Commits
-------

08ac161 [PropertyInfo] remove deprecations, mark TypeInfo as experimental
@fabpot fabpot mentioned this pull request May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants