ReadyMage Help
  • ReadyMage
  • USER PORTAL
    • User Portal Access
    • Change Password
    • Two-Factor Authentication
  • Project Management
    • Project List
    • Project Settings
      • General Info
      • Git Management
      • Environments
      • Members and roles
      • Security
        • Deletion Protection
        • TFA Enforcement
      • Delete Project
  • Application Management
    • Magento Details
    • Domain Management
    • Logs & Monitoring
    • Backups
      • Backup process
      • Disaster recovery process
    • Deployments
      • Deploy without build cache
      • Queue Tab (Launching soon)
      • Settings Tab (Launching soon)
        • Automatic Deployments
        • ReadyMage Maintenance Page
          • Website Access During Maintenance
      • Notifications Tab (Launching soon)
        • Managing email notifications
        • Managing Slack notifications
      • Pipeline Deployments
      • Pipeline Configuration file
        • Migration guide from 0.x.x to 1.0.0
    • SSH Access
      • SSH Usage
      • Database Access using Graphical Interface
      • Troubleshooting
    • IP Whitelist
    • Password Authentication
    • Database & Media
    • Search Engine Bots Discovery
  • Service Management
    • Server-Side Rendering
    • SFTP
    • NewRelic
    • Packagist Modules
    • Cloudflare
  • Infrastructure Management
    • Autoscale
    • Sleep Mode
    • Manage Services
    • Historical Resource Usage
  • PROJECT DEVELOPMENT
    • Node.js version
    • Store access
    • Creating a Production Environment
    • Additional Environments
    • ScandiPWA, PWA Studio, Hyva, or Luma
    • Project Migration to ReadyMage
    • SSH Access for Magento CLI, database and media
    • Code customization and local setup
    • Extension installation
    • Add translations (switch locale)
    • Existing ScandiPWA Project Code Migration
    • Database and media migration
    • Redirect setup
    • Connect CDN and WebP optimization
    • Email setup
    • Changing the Domain & Multi-Store Set up
    • Internal service addresses
    • Kibana filters and useful CLI commands
    • Persistent directories
  • FAQ
    • General
    • Autoscaling
    • Billing
    • User Portal Options
    • Services connected to ReadyMage
    • Hosting, managing resources and autoscaling
    • Source Code Management
    • ScandiPWA and Magento Versions, Commerce Edition and Upgrades
    • Supported software versions
Powered by GitBook
On this page
  • Migration
  • 1. Update configuration file name
  • 2. Update property names
  • 3. Update hooks
  • 3. Update actions
  • Example migration

Was this helpful?

  1. Application Management
  2. Deployments
  3. Pipeline Configuration file

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
PreviousPipeline Configuration fileNextSSH Access

Last updated 10 months ago

Was this helpful?