Migration guide from 0.x.x to 1.0.0

Migration

1. Update configuration file name

First, update configuration file name from .readymage.yaml → readymage.yaml

2. Update property names

Convert camelCase property names to snake_case.

For example:

• schemaVersion → schema_version

• preBuild → pre_build

• postBuild → post_build

3. Update hooks

Contents of hooks have been moved from array type to regular key-values

hooks:
- preBuild: ...
- postBuild: ...

→

hooks:
  pre_build: ...
  post_build: ...

3. Update actions

Copy

...
- copy:
    name: Copy config
    source: app/etc/config-ca.php
    destination: app/etc/config.php
...

→

...
- copy:
    app/etc/config-ca.php: app/etc/config.php
...

Move

...
- move:
    name: Move config
    source: app/etc/config-ca.php
    destination: app/etc/config.php
...

→

...
- move:
    app/etc/config-ca.php: app/etc/config.php
...

Symlink

...
- symlink:
    name: Symlink to target inisde persistent directory
    path: satis/satis.json
    target: satis.json
    persistentTarget: true

- symlink:
    name: Symlink to target inside magento root directory
    path: package2.json
    target: scandipwa/package.json
...

→

...
- symlink:
    satis/satis.json: persistent:satis.json
    package2.json: scandipwa/package.json
...

Example migration

schemaVersion: 0.4.0
environments:
- name: readymage-testinging-env-a
  build:
    hooks:
    - preBuild:
      - copy:
          name: Copy magento php config
          source: app/etc/config-ca.php
          destination: app/etc/config.php
- name: readymage-testinging-env-b
  build:
    hooks:
    - preBuild:
      - copy:
          name: Copy magento php config
          source: app/etc/config-aus.php
          destination: app/etc/config.php
      - copy:
          name: Copy package.json
          source: scandipwa/package-aus.json
          destination: scandipwa/package.json
      - copy:
          name: Copy package-lock.json
          source: scandipwa/package-lock-aus.json
          destination: scandipwa/package-lock.json

→

schema_version: 1.0.0
environments:
- name: readymage-testinging-env-a
  build:
    hooks:
      pre_build:
      - copy:
	  app/etc/config-ca.php: app/etc/config.php
- name: readymage-testinging-env-b
  build:
    hooks:
      pre_build:
      - copy:
          app/etc/config-aus.php: app/etc/config.php
	  scandipwa/package-aus.json: scandipwa/package.json
          scandipwa/package-lock-aus.json: scandipwa/package-lock.json