Skip to content

Commit

Permalink
Update README and UPGRADE, fix composer.json typo, update gitignore
Browse files Browse the repository at this point in the history
  • Loading branch information
tgalopin committed Sep 12, 2022
1 parent ae7a9d0 commit dec9a1d
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 33 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
vendor
composer.lock
.php_cs.cache
.php-cs-fixer.cache
.phpunit.result.cache
12 changes: 7 additions & 5 deletions .php-cs-fixer.dist.php
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
<?php

$finder = PhpCsFixer\Finder::create()->in(__DIR__);
$config = new PhpCsFixer\Config();

return $config->setRules([
return (new PhpCsFixer\Config())
->setRules([
'@Symfony' => true,
'phpdoc_annotation_without_dot' => false,
])
->setFinder($finder);
->setFinder(
PhpCsFixer\Finder::create()
->in(__DIR__)
)
;
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,24 @@
[![Packagist Version](https://img.shields.io/packagist/v/league/flysystem-bundle.svg?style=flat-square)](https://packagist.org/packages/league/flysystem-bundle)
[![Software license](https://img.shields.io/github/license/thephpleague/flysystem-bundle.svg?style=flat-square)](https://github.com/thephpleague/flysystem-bundle/blob/master/LICENSE)

[![SymfonyInsight](https://insight.symfony.com/projects/525fdfa3-d482-4218-b4b9-3c2efc305fac/big.svg)](https://insight.symfony.com/projects/525fdfa3-d482-4218-b4b9-3c2efc305fac)

flysystem-bundle is a Symfony bundle integrating the [Flysystem](https://flysystem.thephpleague.com)
library into Symfony applications.

It provides an efficient abstraction for the filesystem in order to change the storage backend depending
on the execution environment (local files in development, cloud storage in production and memory in tests).

> Note: you are reading the documentation for flysystem-bundle 3.0, which relies on Flysystem 3.
> If you use Flysystem 1.X, use [flysystem-bundle 1.X](https://github.com/thephpleague/flysystem-bundle/tree/1.x).
> If you use Flysystem 2.X, use [flysystem-bundle 2.X](https://github.com/thephpleague/flysystem-bundle/tree/2.3.0).
> If you use Flysystem 1.x, use [flysystem-bundle 1.x](https://github.com/thephpleague/flysystem-bundle/tree/1.x).
> If you use Flysystem 2.x, use [flysystem-bundle 2.x](https://github.com/thephpleague/flysystem-bundle/tree/2.x).
> Read the [Upgrade guide](https://github.com/thephpleague/flysystem-bundle/blob/master/UPGRADE.md) to learn how to upgrade.
## Installation

flysystem-bundle requires PHP 8.0+ and Symfony 5.4+.
flysystem-bundle 3.x requires PHP 8.0+ and Symfony 5.4+.

> If you need support for a lower PHP/Symfony version, consider using
> [flysystem-bundle 2.x](https://github.com/thephpleague/flysystem-bundle/tree/2.x) which support Flysystem 3.x
> and older PHP/Symfony versions.
You can install the bundle using Symfony Flex:

Expand Down
34 changes: 16 additions & 18 deletions UPGRADE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
# Upgrading from 2.0 to 3.0

flysystem-bundle 3.0 dropped support for End-Of-Life versions of PHP, Symfony and Flysystem.

No backward incompatible code change have been directly introduced by this bundle version.
You should read the [Flysystem 3.x changelog](https://github.com/thephpleague/flysystem/blob/3.x/CHANGELOG.md)
for any indirect change that may affect you.

The list of changes is the following:

* Dropped support for PHP 7.x ;
* Dropped support for Symfony 4.2 to 5.3 ;
* Dropped support of Flysystem 2.x ;
* Added support for Azure Blob Storage (`league/flysystem-azure-blob-storage ^3.1`)

# Upgrading from 1.0 to 2.0

flysystem-bundle 2.0 introduces backward incompatible changes, meaning you will need to update
Expand All @@ -9,26 +24,9 @@ changes. You should read

In addition to the library updates, the bundle also changed a bit:

* Add official support for PHP 8 ;
* Add official support for PHP 8.x ;
* Migration to AsyncAWS 1.0 ;
* Drop support for PHP 7.1 ;
* Drop support for Azure, Dropbox, Rackspace and WebDAV adapters (following the main library) ;
* Drop support for null, cache, zip and replicate adapters (following the main library) ;
* Drop support for plugins ;

# Upgrading from 2.0 to 3.0

flysystem-bundle 3.0 relies on Flysystem 3.0, PHP 8.0+ and Flysystem adapters 3.1+.

The changes in this version focus on dropping support for EOL versions of PHP and Symfony and
adding support for Azure Blob Storage.
No new backwards incompatible code changes have been directly introduced by this new bundle version.
You should read the [Flysystem 3.x Change Log](https://github.com/thephpleague/flysystem/blob/3.x/CHANGELOG.md)
for any changes that may effect you.

These changes are;

* Added support for Azure Blob Storage (`league/flysystem-azure-blob-storage ^3.1`)
* Dropped support for PHP 7
* Dropped support of `league/flysystem ^2.0` and older Flysystem adapters `league/flysystem-* ^2.0|3.0.*`
* Dropped support for Symfony 4.2 to 5.3
5 changes: 1 addition & 4 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "league/flysystem-bundle",
"description": "Symfony bundle integrating Flysystem into Symfony 4.4+ applications",
"description": "Symfony bundle integrating Flysystem into Symfony 5.4+ applications",
"type": "symfony-bundle",
"license": "MIT",
"authors": [
Expand Down Expand Up @@ -42,9 +42,6 @@
"symfony/var-dumper": "^5.4|^6.0",
"symfony/yaml": "^5.4|^6.0"
},
"conflict": {
"league/flysystem-cached-adapter": "<1.0.9"
},
"config": {
"preferred-install": {
"*": "dist"
Expand Down

0 comments on commit dec9a1d

Please sign in to comment.