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

Upgrade flysystem v2 #1198

Merged
merged 1 commit into from
Jan 29, 2025
Merged

Upgrade flysystem v2 #1198

merged 1 commit into from
Jan 29, 2025

Conversation

jaapio
Copy link
Member

@jaapio jaapio commented Jan 21, 2025

This is an effort to abstract away the logic provided by FlySystem. FlySystem has some challenges when updating, but also limits the way filesystems are implemented in this project. By adding a new package we can migrate to a new version of flysystem, and even introduce other file system adapters when people want to use a different system. Although the latter requires some extra work to allow people to use the flysystem based file finder.

The new system has been implemented in a backward compatible way, so other projects depending on this project can migrate when they are ready.

@jaapio jaapio force-pushed the upgrade-flysystem-v2 branch 6 times, most recently from e9dd577 to ce3ee26 Compare January 28, 2025 21:31
@jaapio jaapio requested a review from linawolf January 28, 2025 21:42
@jaapio jaapio marked this pull request as ready for review January 28, 2025 21:42
@jaapio
Copy link
Member Author

jaapio commented Jan 28, 2025

@linawolf, I would like to hear what you think about these changes, please do NOT update the branch as a lot of composer steps have been taken by me. I will take care of merging when we agree this is a path we should take.

I think this path will also allow us to get files outside the documentation directory for typo3 projects, by replacing flysystem with another filesystem like symfony/filesystem for example.

@jaapio jaapio force-pushed the upgrade-flysystem-v2 branch from ce3ee26 to d3bd002 Compare January 29, 2025 19:33
The filesystem component makes an abstraction between guides and
flysystem. This makes it easier to maintain the project when external
dependencies are introducing breaking changes. The filesystem component
is just focused on the needs of phpDocumentor and shall not be seen
as a stand alone component to be used by other projects.
@jaapio jaapio force-pushed the upgrade-flysystem-v2 branch from d3bd002 to b281d2d Compare January 29, 2025 19:36
@jaapio jaapio enabled auto-merge January 29, 2025 19:38
@jaapio jaapio merged commit e0f5b28 into main Jan 29, 2025
48 of 49 checks passed
@jaapio jaapio deleted the upgrade-flysystem-v2 branch January 29, 2025 19:39
@phpdoc-bot
Copy link

💚 All backports created successfully

Status Branch Result
1.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

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.

2 participants