An open API service indexing awesome lists of open source software.

https://github.com/fortrabbit/craft-auto-migrate

Run Craft migrations automatically
https://github.com/fortrabbit/craft-auto-migrate

composer composer-plugin craft craftcms

Last synced: 2 months ago
JSON representation

Run Craft migrations automatically

Awesome Lists containing this project

README

          

## Craft Auto Migrate

A Composer plugin that runs `craft migrate/all` and `craft project-config/apply` after `composer install`, **if Craft is installed**.

### Install

Require the package as a dependency of a plugin or in the composer.json of your project.

```
composer require fortrabbit/craft-auto-migrate
```

### Disable

By setting the ENV var `DISABLE_CRAFT_AUTOMIGRATE=1` you disable the plugin.

### Project Config

By setting the ENV var `PROJECT_CONFIG_FORCE_APPLY=1` the `project-config/apply` command is executed with the `--force` flag.

The file `config/project/project.yaml` will be removed after applying, unless you set the ENV var `KEEP_PROJECT_CONFIG=1` or composer install is running locally (interactive mode).
This behaviour was added in `2.5.0` to prevent re-applying the Project Config in the Craft CP.

### Troubleshooting
In case you get an `Your project config YAML files contain pending changes` error after a deploy or during first-time setup, try the following to resolve the issue:
- If you are on Craft 3, set `KEEP_PROJECT_CONFIG=1` otherwise leave it as the default `0`
- Delete the local and remote copies of the following files:
```
storage/config-deltas/*.yaml*
storage/config-backups/*.yaml*
```