Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carbonpackages/carbon.automigrate
Automatic node migrations for Neos CMS
https://github.com/carbonpackages/carbon.automigrate
carbon deployment migration neos-plugin neoscms
Last synced: 3 months ago
JSON representation
Automatic node migrations for Neos CMS
- Host: GitHub
- URL: https://github.com/carbonpackages/carbon.automigrate
- Owner: CarbonPackages
- License: gpl-3.0
- Created: 2024-10-22T18:31:55.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-22T19:00:45.000Z (4 months ago)
- Last Synced: 2024-11-22T21:05:05.876Z (3 months ago)
- Topics: carbon, deployment, migration, neos-plugin, neoscms
- Language: PHP
- Homepage:
- Size: 24.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Carbon.AutoMigrate
Sometimes, things change. This package helps you to migrate old installation to up-to-date installations. This help
to run migrations after deployments.
## Installation
This package is available via [packagist]. Run `composer require carbon/automigrate --no-update` in your
site package. After that, run `composer update` in your root directory.
## How to use it
Add your node migrations version numbers to your `Settings.yaml`:
```yaml
Carbon:
AutoMigrate:
node:
20241005070000: true
20241005090000: true
```
Configure your stack to run `./flow node:automigrate` after `./flow doctrine:migrate`. The command will check if the
migrations are available, checks if the migrations has already been applied, and if not, the migrations get's applied.
### Options
Run `./flow help node:automigrate` to see the options:
```bash
--confirmation Confirm application of this migration, only needed if the given migration contains any warnings.
--dry-run If true, no changes will be made
```
## Aditional migration helper
### [RenamePropertyValuesMigration](Classes/Migrations/RenamePropertyValuesMigration.php)
This can be used to rename one or multiply property values. This is also possible with default yaml, but need many
lines, if you have multiple values to change.
A migration could look like this:
```yaml
up:
comments: "Switch property values"
migration:
- filters:
- type: "NodeType"
settings:
nodeType: "Foo.Bar:Mixin.Direction"
withSubTypes: true
transformations:
- type: 'Carbon\AutoMigrate\Migrations\RenamePropertyValuesMigration'
settings:
propertyName: direction
values:
oldValue: newValue
northEast: topRight
northWest: topLeft
southEast: bottomRight
southWest: bottomLeft
down:
comments: "Revert property value switch"
migration:
- filters:
- type: "NodeType"
settings:
nodeType: "Foo.Bar:Mixin.Direction"
withSubTypes: true
transformations:
- type: 'Carbon\AutoMigrate\Migrations\RenamePropertyValuesMigration'
settings:
propertyName: direction
values:
newValue: oldValue
topRight: northEast
topLeft: northWest
bottomRight: southEast
bottomLeft: southWest
```
### [RenameNodeTypesMigration](Classes/Migrations/RenameNodeTypesMigration.php)
This can be used if you want to rename NodeTypes. This not only change the `nodetype` in the table
`neos_contentrepository_domain_model_nodedata`, it also set the `siteresourcespackagekey` in
`neos_neos_domain_model_site` if the node type match.
You have to create a PHP file in your package under `Migrations/Mysql`
```php
"Vendor.Example:Content.NewNodeType",
"Vendor.Example:Document.OldNodeType" => "Vendor.Example:Document.NewNodeType",
];
}
```
The migration will automatically run if you run `./flow doctrine:migrations`.
[packagist]: https://packagist.org/packages/carbon/automigrate