https://github.com/commercetools/project-config-replication

An interface to propagating changes across commercetools projects
https://github.com/commercetools/project-config-replication

Last synced: 4 months ago
JSON representation

An interface to propagating changes across commercetools projects

• Host: GitHub
• URL: https://github.com/commercetools/project-config-replication
• Owner: commercetools
• Created: 2018-08-15T16:02:07.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-04-29T03:54:06.000Z (about 3 years ago)
• Last Synced: 2025-02-25T14:56:09.112Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 492 KB
• Stars: 2
• Watchers: 61
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
ct-project-config-replication

====

This tool provides a scriptable interface to applying changes between commercetools projects.

Given a directory of files each with a change (referred to as a migration), this tool will apply them to the configured project.

Warning

====

This project is in its infancy and should not be considered production ready!

Installation

----

Install this project's dependencies by running `npm install`.  Run `npm build` to build this project.

How to write a migration

---

A migration is a JSON file with a few fields defined.  All migrations should have top-level "type", "action" and "key" fields defined.  These refer to the resource type (product, productType, etc), the action to apply ("create", "update", "delete"), and the key to locate the resource on commercetools.  Additionally migrations with the type "create" must have a top-level field "payload", and migrations with type "update" must have a top-level field "actions".  The payload defines the resource draft and the actions is an array of update actions to apply to the resource.  There are examples included in the examples directory.  Each migration's filename must begin with a 5 digit number, 00000 to 99999 indicating the order in which to apply the migrations.  Also the filename should be structured like the following: 00000-action-description.json.  Lower-numbered migrations are run first.

Configuration

---

There are several optional flags to configure this program, alternatively you may use environment variables.  See the output of `node dist/index.js --help` below for more information.

```

  Usage: index [options] 

  Options:

    -v, --version                      output the version number

    -c, --clientId [clientId]          Client ID

    -s, --clientSecret [clientSecret]  Client Secret

    -p, --projectKey [projectKey]      Project Key

    -a, --authUrl [authUrl]            Auth URL (default: https://auth.commercetools.co)

    -i, --apiUrl [apiUrl]              API URL (default: https://api.commercetools.co)

    -t, --concurrency [concurrency]    Concurrency (default: 10)

    -d, --dryRun                       Dry Run

    -h, --help                         output usage information

  Environment Variables:

    CLIENT_ID

    CLIENT_SECRET

    PROJECT_KEY

    AUTH_URL

    API_URL

```

Running

---

Run the program via `node dist/index.js [options] `

More Info

---

* This script will create a custom object "ct-migrations/ct-last-applied" in your commerctools project to keep track of the last applied migration.  This script relies on this custom object, alter it at your own risk.

* In the future this might be available to install via npm, to ease integration into a CD pipeline.