{"id":30138457,"url":"https://github.com/tanoconsulting/ezmigrationbundle2","last_synced_at":"2025-08-11T01:14:30.327Z","repository":{"id":48785995,"uuid":"311738777","full_name":"tanoconsulting/ezmigrationbundle2","owner":"tanoconsulting","description":"This bundle makes it easy to handle Ibexa DXP 3 (aka. eZPlatform 3) content upgrades/migrations","archived":false,"fork":false,"pushed_at":"2023-06-16T09:01:50.000Z","size":967,"stargazers_count":9,"open_issues_count":6,"forks_count":7,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-07-04T07:42:27.732Z","etag":null,"topics":["ci","continuous-integration","database-migrations","deployment","ezplatform","updates"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tanoconsulting.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["tanoconsulting"]}},"created_at":"2020-11-10T17:42:50.000Z","updated_at":"2025-05-24T10:44:32.000Z","dependencies_parsed_at":"2023-02-12T22:46:02.815Z","dependency_job_id":null,"html_url":"https://github.com/tanoconsulting/ezmigrationbundle2","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/tanoconsulting/ezmigrationbundle2","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tanoconsulting%2Fezmigrationbundle2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tanoconsulting%2Fezmigrationbundle2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tanoconsulting%2Fezmigrationbundle2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tanoconsulting%2Fezmigrationbundle2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tanoconsulting","download_url":"https://codeload.github.com/tanoconsulting/ezmigrationbundle2/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tanoconsulting%2Fezmigrationbundle2/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269816862,"owners_count":24479846,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-10T02:00:08.965Z","response_time":71,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ci","continuous-integration","database-migrations","deployment","ezplatform","updates"],"created_at":"2025-08-11T01:14:25.894Z","updated_at":"2025-08-11T01:14:30.271Z","avatar_url":"https://github.com/tanoconsulting.png","language":"PHP","funding_links":["https://github.com/sponsors/tanoconsulting"],"categories":[],"sub_categories":[],"readme":"TanoConsulting eZ-Migration-2 Bundle\n====================================\n\nThe replacement of [kaliop/ezmigrationbundle](https://github.com/kaliop-uk/ezmigrationbundle) for eZPlatform 3 (aka. Ibexa DXP).\n\nThis bundle makes it easy to programmatically deploy changes to eZPlatform database structure and contents.\n\nIt is inspired by the [DoctrineMigrationsBundle](https://symfony.com/doc/current/bundles/DoctrineMigrationsBundle/index.html)\n\n_NB: eZMigrationBundle2 version 1.0 is a fork of eZMigrationBundle version 6.3.0, regardless of the long time it spent\nin beta state_\n\n\n## Requirements\n\n* PHP 7.3 or later.\n\n* eZPlatform 3 (aka. Ibexa DXP).\n\nFor Ibexa DXP 4, head on to [tanoconsulting/ibexa-migration-bundle](https://github.com/tanoconsulting/ibexa-migration-bundle). For eZPlatform 1-2 and earlier, to\n[kaliop-uk/ezmigrationbundle](https://github.com/kaliop-uk/ezmigrationbundle).\n\n\n## Installation\n\nIn either `require` or `require-dev` at the end of the bundle list in the composer.json file add:\n\n    composer require 'tanoconsulting/ezmigrationbundle2:^1.0'\n\nSave it and run\n\n    composer update --dev tanoconsulting/ezmigrationbundle2\n\nThis will install the bundle and all its dependencies.\n\nThen make sure that the bundle is active, generally by editing `config/bundles.php`\n\n### Checking that the bundle is installed correctly\n\nIf you run `php bin/console` you should see the following new commands in the list:\n\n    kaliop\n      kaliop:migration:generate\n      kaliop:migration:mass_migrate\n      kaliop:migration:migrate\n      kaliop:migration:migration\n      kaliop:migration:resume\n      kaliop:migration:status\n\nThis indicates that the bundle has been installed and registered correctly.\n\n### Updating the bundle\n\nTo get the latest version, you can update the bundle to the latest available version by using `composer`\n\n    composer update tanoconsulting/ezmigrationbundle2\n\nFor upgrades from kaliop/ezmigrationbundle, see the instructions in [ezmigrationbundle_to_ezmigrationbundle2.md](Resources/doc/Upgrading/ezmigrationbundle_to_ezmigrationbundle2.md).\n\nFor upgrades from beta versions of ezmigrationbundle2, see the instructions at the bottom of this readme.\n\n\n## Getting started\n\nAll commands accept the standard Symfony/eZPlatform options, although some of them might not have any effect on the\ncommand's execution.\n\n### Generating a new, empty migration definition file\n\nThe bundle provides a command to easily generate a new blank migration definition file.\n\nFor example:\n\n    php bin/console kaliop:migration:generate --format=yml\n\nThe above command will place a new yml skeleton file in the `MigrationsDefinitions` directory in `./src/`.\n\nIf the directory does not exist then the command will create it for you.\nIf the command is successful it will create a new yml file named with the following pattern: `YYYYMMDDHHMMSS_placeholder.yml`.\nYou are encouraged to rename the file and change the `placeholder` part to something more meaningful, but please keep\nthe timestamp part and underscore, as well as the extension.\n\n_(the contents of the skeleton Yaml file are stored as twig template)_\n\n### Listing all migrations and their status\n\nTo see all the migrations definitions available in the system and whether they have been applied or not simply run the\nstatus command in your eZPlatform root directory:\n\n    php bin/console kaliop:migration:status\n\nThe list of migrations which have been already applied is stored in the database, in a table named `kaliop_migrations`.\nThe bundle will automatically create the table if needed.\nIn case you need to use a different name for that table, you can change the Symfony parameter `ez_migration_bundle.table_name`.\n\n### Applying migrations\n\nTo apply all available migrations run the migrate command in your eZPlatform root directory:\n\n     php bin/console kaliop:migration:migrate\n\nNB: if you just executed the above command and got an error message because the migration definition file that you had\njust generated is invalid, do not worry - that is by design. Head on to the next paragraph...\n\nNB: migrations execute by the default as the admin user with ID 14. Without this user account in the database, you must\nspecify the use of another admin account by passing the `-a` flag.\n\n#### Applying a single migration file\n\nTo apply a single migration run the migrate command passing it the path to its definition, as follows:\n\n    php bin/console kaliop:migration:migrate --path=src/MyNamespace/MyBundle/MigrationVersions/20160803193400_a_migration.yml\n\nNB: you can specify as well a folder with the `--path` flag, in which case all the migration definitions contained in that\nfolder will be executed.\n\n### Editing migration files\n\nSo far so good, but what kind of actions can be actually done using a migration?\n\nEach migration definition consists of a series of steps, where each step defines an action.\n\nA simple example of a migration to create a 'folder' content is:\n\n    -\n        mode: create\n        type: content\n        content_type: folder\n        parent_location: 2\n        attributes:\n            name: hello world\n\nIn a Yaml migration, you can execute the following types of actions:\n- creation, update and deletion of [Contents](Resources/doc/DSL/Contents.yml)\n- creation, update and deletion of [ContentTypes](Resources/doc/DSL/ContentTypes.yml)\n- creation, update and deletion of [ContentTypeGroups](Resources/doc/DSL/ContentTypeGroups.yml)\n- deletion of [Content Versions](Resources/doc/DSL/ContentVersions.yml)\n- creation and deletion of [Languages](Resources/doc/DSL/Languages.yml)\n- creation, update and deletion of [Locations](Resources/doc/DSL/Locations.yml)\n- creation, update and deletion of [ObjectStates](Resources/doc/DSL/ObjectStatesAndGroups.yml)\n- creation, update and deletion of [ObjectStateGroups](Resources/doc/DSL/ObjectStatesAndGroups.yml)\n- creation, update and deletion of [Roles](Resources/doc/DSL/RolesAndPolicies.yml)\n- creation, update and deletion of [Sections](Resources/doc/DSL/Sections.yml)\n- creation and deletion of [Tags](Resources/doc/DSL/Tags.yml) (from the Netgen Tags Bundle)\n- creation and deletion of [URL aliases](Resources/doc/DSL/UrlAliases.yml) and [wildcards](Resources/doc/DSL/UrlWildcards.yml)\n- creation, update and deletion of [Users](Resources/doc/DSL/UsersAndGroups.yml)\n- creation, update and deletion of [UserGroups](Resources/doc/DSL/UsersAndGroups.yml)\n- purging and recovering Contents from the [Trash](Resources/doc/DSL/Trash.yml)\n- creation, appending, copy, renaming and deletion of [files](Resources/doc/DSL/Files.yml)\n- execution of [SQL queries](Resources/doc/DSL/SQL.yml)\n- execution of [command-line scripts](Resources/doc/DSL/Processes.yml)\n- execution of methods of Symfony services](Resources/doc/DSL/Services.yml)\n- execution of [php functions and static methods](Resources/doc/DSL/PHP.yml)\n- execution of [http calls](Resources/doc/DSL/HTTP.yml)\n- sending of [email](Resources/doc/DSL/Mails.yml)\n- looping over [arrays](Resources/doc/DSL/Loops.yml) and executing one of the above actions on each element\n- canceling, snoozing or suspending the [migration itself](Resources/doc/DSL/Migrations.yml)\n- generating and saving new [migration definitions](Resources/doc/DSL/MigrationDefinitions.yml)\n\nMore details on all supported migration-language features are in the [DSL Language description](Resources/doc/DSL/README.md)\n\n### Custom migrations\n\nFor more specific needs, you can also use 2 other types of migrations:\n- SQL migrations\n- PHP migrations\n\n#### SQL migrations\n\nExample command to generate an SQL migration definition:\n\n     php bin/console kaliop:migration:generate create-new-table --format=sql\n\nThis will create the following file, which you are free to edit:\n\n    ./src/MigrationsDefinitions/2021XXYYHHMMSS_mysql_create-new-table.sql\n\n*NB* if you rename the sql file, keep in mind that the type of database to which it is supposed to apply is the part\nof the filename between the first and second underscore characters.\nIf you later try to execute that migration on an eZPublish installation running on, say, PostgreSQL, the migration\nwill fail. You are of course free to create a specific SQL migration for a different database type.\n\nThe Migration bundle itself imposes no limitations on the type of databases supported, but as it is based on the\nDoctrine DBAL, it will only work on the databases that Doctrine supports.\n\n*NB* you can also save the SQL statement to execute in a yml-formatted migration file. This gives you access to more\noptions, such as setting and resolving references. Yml-formatted migration files do not need to have the db type in their name.\n\n*NB* if the SQL statement (or statements) in your migration is too long, the migration might fail or be only partially\napplied, in some cases (such as when using MySQL) without even reporting an error. If you need to execute multiple, long\nqueries, you are better off splitting them, either in many .sql migrations, or in a single .yml migration with sql steps.\n\n#### PHP migrations\n\nIf the type of manipulation that you need to do is too complex for either YML or SQL, you can use a php class as\nmigration definition. To generate a PHP migration definition, execute:\n\n     php bin/console kaliop:migration:generate AMigrationClass --format=php\n\nThis will create the following file, which you are free to edit:\n\n    ./src/MigrationsDefinitions/2021XXYYHHMMSS_AMigrationClass.php\n\nAs you can see in the generated definition, the php class to be used for a migration needs to implement a specific\ninterface. The Symfony DIC container is passed to the migration class so that it can access from it all the services,\nparameters and other thing that it needs.\n\nFor a more detailed example of a migration definition done in PHP, look [in the MigrationVersions](MigrationVersions/20100101000200_MigrateV1ToV2.php) folder of this very bundle.\n\n*NB* if you rename the php file, keep in mind that the filename and the name of the class it contains are tied - the\nstandard autoloading mechanism of the application does not apply when loading the migration definition. This is also\nthe reason why the php classes used as migrations should not use namespaces.\n\n*NB* it is also possible to run any method of any existing Symfony service just by declaring it as migration step\nin a yaml migration. See the [relevant DSL](Resources/doc/DSL/Service.yml) for details.\n\n*NB* it is also possible to run any existing php function or static class method just by declaring it as migration step\nin a yaml migration. See the [relevant DSL](Resources/doc/DSL/PHP.yml) for details.\n\n### Re-executing failed migrations\n\nThe easiest way to re-execute a migration in 'failed' status, is to remove it from the migrations table:\n\n    php bin/console kaliop:migration:migration migration_name --delete\n\nAfter removing the information about the migration from the migrations table, running the `migrate` command will execute it again.\n\n\n## Usage of transactions / rolling back changes\n\nBy default the bundle runs each migration in a database transaction.\nThis means that if a step fails, all the previous steps get rolled back, and the database is left in its original state.\nThis is a safety feature built in by design;\n* if you prefer the migration steps to be executed in separate transactions the easiest way is to create a separate\n  migration file for each step\n* you can use the command-line flag `-u` to disable usage of transactions by the migrate command\n\nNote also that by default the `migrate` command stops on the 1st failed migration, but it can be executed with a flag\nto allow it to continue and execute all available migrations even in case of failures.\n\nAs for rolling back changes: given the nature of the eZPublish API, rolling back changes to Content is not an easy feat.\nAs such, the bundle does not provide built-in support for rolling back the database to the version it had before\napplying a given migration. We recommend always taking a database snapshot before applying migrations, and use it in\ncase you need to roll back your changes. Another approach consists in writing a separate migration to undo the changes.\n\n\n## Customizing the migration logic via Event Listeners\n\nAn easy way to hook up custom logic to the execution of migrations - without having to implement your own customized\naction executors - is to use Event Listeners.\n\nTwo events are fired *for each step* during execution of migrations:\n\n    * ez_migration.before_execution =\u003e listeners receive a BeforeStepExecutionEvent event instance\n    * ez_migration.step_executed =\u003e listeners receive a StepExecutedEvent event instance\n\nAn event is fired only in case a migration fails because a step throws a specific migration abort exception:\n\n    * ez_migration.migration_aborted =\u003e listeners receive a MigrationAbortedEvent event instance\n\nAn event is fired when a migration is being generated using the `kaliop:migration:generate` command, allowing to alter\nthe data that will be serialized as migration steps:\n\n    * ez_migration.migration_generated =\u003e listeners receive a MigrationGeneratedEvent event instance\n\nIn order to act on those events, you will need to declare tagged services, such as for ex:\n\n    my.step_executed_listener:\n        class: my\\helper\\StepExecutedListener\n        tags:\n            - { name: kernel.event_listener, event: ez_migration.step_executed, method: onStepExecuted }\n\nand the corresponding php class:\n\n    use Kaliop\\eZMigrationBundle\\API\\Event\\StepExecutedEvent;\n\n    class StepExecutedListener\n    {\n        public function onStepExecuted(StepExecutedEvent $event)\n        {\n            // do something...\n        }\n    }\n\nEvent Subscribers are supported as an alternative to Event Listeners, as is standard with Symfony projects.\n\n\n## Known Issues and limitations\n\n* unlike the Doctrine Migrations Bundle, this bundle does not support rollback of changes. Read above for the reason why.\n\n* if you are using the Doctrine Migrations Bundle to manage your schema, you will get spurious sql created to handle the\n  database tables belonging to Kaliop Migrations Bundle.\n  For the moment, the best workaround is to use the `filter-expression` parameter on the command-line when running\n  `doctrine:migrations:diff` and friends, with a value of `kaliop_migrations_*`\n\n* fatal errors when running a migration can manifest themselves when you are using the Solr Search Engine Bundle.\n  In this case the problem is compounded the fact that, even if a node or object is sent to Solr from within a database\n  transaction, the Solr search index might be configured to only commit received data within a short time delay.\n  A known workaround involve:\n    - separate your migration steps into separate migrations\n    - running the migrations each in its own transaction (and process) by using the `-p` flag to the `migrate` command\n    - adding `sleep` migration steps to migrations 2 .. N\n    - and/or configuring Solr to always commit changes to the index immediately (eg. disable `commitwithin`)\n\n* when using SOLR in multi-core configurations and getting a `java.lang.NegativeArraySizeException` error, you will have\n  to set a lower value than the default 2147483647 for parameter `ez_migration_bundle.query_limit`\n\n* if you get fatal errors without any error message when running a migration which involves a lot of content changes,\n  such as f.e. altering a contentType with many contents, it might be that you are running out of memory for your\n  php process.\n  Known workarounds involve:\n    - increase the maximum amount of memory allowed for the php script by running it with option '-d memory_limit=-1'\n    - execute the migration command using a Symfony environment which has reduced logging and kernel debug disabled:\n      the default configuration for the `dev` environment is known to leak memory\n    - transform the migration, where possible, into one which loads and modifies contents one by one in a loop, instead\n        of modifying them all in a single action. See an example of using loops [here](Resources/doc/Cookbook/move_all_children_of_a_location.yml).\n\n* if you get fatal errors with the message 'You cannot create a service (\"request\") of an inactive scope (\"request\")',\n  take a look at the following issue for a possible explanation and ideas for workarounds:\n  https://jira.ez.no/browse/EZP-24691\n\n* when updating a Role, you have to specify in the migration *all* the policies for it. Any existing policies that are not\n  in the yml file will be removed.\n  To make it easy to create a migration for updating a role, please use the `migration:generate` command using the `--type=role` flag\n\n* take care when creating content types: the eZPublish API, used internally by the migration bundle, will let you use dash\n  characters in the content type identifiers, even if the resulting content types will then be unusable, eg.\n\n  Example of an invalid definition:\n\n            type: ezstring\n            name: Topbar-hover-color\n            identifier: topbar-hover-color\n\n* when eZ is set up in cluster mode, if you are setting references to the path of a content field of type ezimage,\n  ezbinaryfile or ezmedia, or generating a migration for creating/updating it, the value you will get for the path will\n  not be the absolute path on disk, but the path relative to the 'nfsvar' directory, which makes it unsuitable for\n  being used directly in eg. a content/create migration. Check out the example in the Cookbook for how to deal with this.\n\n\n## Frequently asked questions\n\n### How can I update a specific content which has a different Id on dev, test and prod environments?\n\nA: use the 'reference/set' migration step to define a reference for the desired content Id, and use a Symfony parameter\nto store a different value for each Symfony environment. For example:\n\n    -\n        type: reference\n        mode: set\n        identifier: content_id_ref\n        value: '%a.parameter.name%'\n\n    -\n        type: content\n        mode: update\n        match:\n            content_id: \"reference:content_id_ref\"\n        etc: ...\n\nNote that there are many more solutions for this issue, sych as making sure your target Contents and Locations have\nthe same Remote_id in all environments, or passing values for references as options to the `migrate` command-line.\n\n### How to update an existing Role to change its policies?\n\nWhen using a migration to update a Role, you must define ALL its policies. Any not defined will be removed.\nThe safest and simplest way to make sure that you do not forget any of the existing policies is to first generate an\nupdate migration that has the complete specification of the role as it currently is defined, and then edit manually.\n\nExample command to create such a migration:\n\n    php bin/console kaliop:migration:generate --type=role --mode=update --match-type=identifier --match-value=Anonymous bundleName\n\n### When dumping a Content into a yml migration via the `generate` command, the list of attributes is empty\n\nA: this is most likely due to using a bad language configuration\n\n### Are there examples of implementing common tasks which require complex migrations?\n\nA: yes, please take a look in folder [Resources/doc/Cookbook/](Resources/doc/Cookbook/)\n\n### Can I run an external tool (command-line script) as part of a migration?\n\nA: sure. Take a look at the [relevant dsl](Resources/doc/DSL/Processes.yml) and [cookbook example](Resources/doc/Cookbook/generate_screenshot_of_video.yml)\n  for details.\n\n\n## Extending the bundle\n\n### Supporting custom migrations\n\nThe bundle has been designed to be easily extended in many ways, such as:\n* adding support for custom/complex field-types\n* adding support for completely new actions in the Yml definitions\n* adding support for a new file format for storing migration definitions\n* adding support for new resolvers for the custom references in the migration definitions\n* taking over the way that the migrations definitions are loaded from the filesystem or stored in the database\n* etc...\n\nFollowing Symfony best practices, for the first 4 options in the list above all you need to do is to create a service\nand give it an appropriate tag (the class implementing service should of course implement an appropriate interface).\n\nTo find out the names of the tags that you need to implement, as well as for all the other services which you can\noverride, take a look at the [services.yml file](Resources/config/services.yml).\n\nIt is also possible to define custom event listeners/subscribers to expand migration execution logic. See the dedicated\nparagraphs above for more details.\n\n\n## Running tests\n\nThe bundle uses PHPUnit to run functional tests.\n\n### Running tests in a working eZPublish / eZPlatform installation\n\nTo run the tests:\n\n    export KERNEL_CLASS=App\\Kernel (or whatever you renamed it to)\n    export APP_ENV=behat (or whatever your environment is)\n\n    bin/phpunit --stderr -c vendor/tanoconsulting/ezmigrationbundle2/phpunit.xml.dist\n\n*NB* the tests do *not* mock interaction with the database, but create/modify/delete many types of data in it.\nAs such, there are good chances that running tests will leave stale/broken data.\nIt is recommended to run the tests suite using a dedicated eZPublish installation or at least a dedicated database.\n\n### Setting up a dedicated test environment for the bundle\n\nA safer choice to run the tests of the bundle is to set up a dedicated environment, similar to the one used when the test\nsuite is run on GitHub Actions.\nThe advantages are multiple: on one hand you can start with any version of eZPublish you want; on the other you will\nbe more confident that any tests you add or modify will also pass on GitHub.\nThe disadvantages are that you will need Docker and Docker-compose, and that the environment you will use will look\nquite unlike a standard eZPublish setup! Also, it will take a considerable amount of disk space and time to build.\n\nSteps to set up a dedicated test environment and run the tests in it:\n\n    git clone --depth 1 https://github.com/tanoconsulting/euts.git teststack\n    # if you have a github auth token, it is a good idea to copy it now to teststack/docker/data/.composer/auth.json\n\n    # this config sets up a test environment with eZPlatform 3.3 running on php 8.0 / ubuntu jammy\n    export TESTSTACK_CONFIG_FILE=Tests/environment/.euts.3.3.env\n\n    ./teststack/teststack build\n    ./teststack/teststack runtests\n    ./teststack/teststack stop\n\nYou can also run a single test case:\n\n    ./teststack/teststack runtests ./Tests/phpunit/01_CollectionsTest.php\n\nNote: this will take some time the 1st time your run it, but it will be quicker on subsequent runs.\nNote: make sure to have enough disk space available.\n\nIn case you want to run manually commands, such as the symfony console:\n\n    ./teststack/teststack console cache:clear\n\nOr easily get to a database shell prompt:\n\n    ./teststack/teststack dbconsole\n\nOr command-line shell prompt to the Docker container where tests are run:\n\n    ./teststack/teststack shell\n\nThe tests in the Docker container run using the version of debian/php/eZPlatform kernel specified in the file\n`Tests/environment/.euts.3.3.env`, as specified in env var `TESTSTACK_CONFIG_FILE`.\nIf no value is set for that environment variable, a file named `.euts.env` is looked for.\nIf no such file is present, some defaults are used, you can check the documentation in ./teststack/README.md to find out\nwhat they are.\nIf you want to test against a different version of eZ/php/mysql/debian, feel free to:\n- create the `.euts.env` file, if it does not exist\n- add to it any required var (see file `teststack/.euts.env.example` as guidance)\n- rebuild the test stack\n- run tests the usual way\n\nYou can even keep multiple test stacks available in parallel, by using different env files, eg:\n- create a file `.euts.env.local` and add to it any required env var, starting with a unique `COMPOSE_PROJECT_NAME`\n- build the new test stack via `./teststack/teststack. -e .euts.env.local build`\n- run the tests via: `./teststack/teststack -e .euts.env.local runtests`\n\n\n## Our Backward Compatibility Promise\n\nThis bundle adheres to Semantic Versioning principles.\n\nHowever, backward compatibility comes in many different flavors. In fact, almost every change can potentially break an\napplication. For example, if we add a new method to a class, this will break an application which extended that class and\nadded the same method, but with a different method signature.\n\nThis section is dedicated to explain in detail which guidelines inform the choice of incrementing the major/minor/patch\nnumber for every new release of the bundle.\n\n### For developers _using_ the bundle\n\nAdherence to Semantic versioning is implemented via the following:\n\n- existing migrations will continue to work across all minor and patch version increases\n- new migration steps and new supported elements for existing migration steps might be introduced in minor versions, but\n  not in patch versions\n- any migration steps or step element targeted for removal will first be deprecated for at least one minor version. When\n  that happens, said element will be immediately removed from the DSL documentation, and `@deprecated` or `BC` comments\n  added to the codebase next to where it is handled\n- the syntax for cli commands will continue to work across all minor and patch version increases\n- new options for existing cli commands, and new commands, might be introduced in minor versions, but not in patch versions\n- the textual output of existing cli commands might be altered in any version - please do not rely on it having a fixed\n  format to parse it\n- events emitted by the bundle will continue to work across all minor and patch version increases\n- new events might be introduced in minor versions, but not in patch versions\n\n### For developers _extending_ or _modifying_ the bundle\n\nThings are a bit more sketchy in terms of the internals of the bundle, ie. PHP classes and Symfony services.\nAlthough great care is taken to avoid breaking user code which extends existing classes or redefines existing services,\nthis is not always possible.\n\n- any change which might have a potential impact on developers _extending_ or _modifying_ the bundle should not happen\n  in patch versions, but it might happen in minor versions. Any such change will only be made if there is a compelling\n  reason to do so (ie. mostly because it is required to fix a bug or to make possible implementation of important new\n  functionality) and be documented in the NEWS file.\n\n\n## Beta version upgrades\n\n### Upgrading from alpha/beta versions to 1.0\n\n* Make sure you read carefully all the BC notes in the [release notes](WHATSNEW.md)\n\n* Run the migration named `20220101000200_FixExecutedMigrationsPaths.php`, eg:\n\n        php bin/console kaliop:migration:migrate --path vendor/tanoconsulting/ezmigrationbundle/MigrationsDefinitions\n\n\n[![License](https://poser.pugx.org/tanoconsulting/ezmigrationbundle2/license)](https://packagist.org/packages/tanoconsulting/ezmigrationbundle2)\n[![Latest Stable Version](https://poser.pugx.org/tanoconsulting/ezmigrationbundle2/v/stable)](https://packagist.org/packages/tanoconsulting/ezmigrationbundle2)\n[![Total Downloads](https://poser.pugx.org/tanoconsulting/ezmigrationbundle2/downloads)](https://packagist.org/packages/tanoconsulting/ezmigrationbundle2)\n\n[![Build Status](https://github.com/tanoconsulting/ezmigrationbundle2/actions/workflows/ci.yml/badge.svg)](https://github.com/tanoconsulting/ezmigrationbundle2/actions/workflows/ci.yml)\n[![Code Coverage](https://codecov.io/gh/tanoconsulting/ezmigrationbundle2/branch/main/graph/badge.svg)](https://codecov.io/gh/tanoconsulting/ezmigrationbundle2/tree/main)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftanoconsulting%2Fezmigrationbundle2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftanoconsulting%2Fezmigrationbundle2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftanoconsulting%2Fezmigrationbundle2/lists"}