Sync Project Configs

What are we doing here?
In case you store your project configurations in the database you will need to make sure that both changes made in production as well as new changes added for new features all end up at the right time in all your environments.
So here we describe one possible approach to sync project configurations between local, development, staging and production environments.
Set up CLI environment variables
For easier working with multiple projects and environments first set up a .livingdocs-cli dotfile: Set up your cli dotfile​
Commands you can use to sync configs
Download project config
Download:
1
npx livingdocs-cli project-config:download --format json --project projectA --env development
Copied!
Publish changes
1
# plan update and verify only the expected properties are updated
2
npx livingdocs-cli project-config:plan --project projectA --env development
3
​
4
# if everything looks ok, do the update
5
npx livingdocs-cli project-config:publish --project projectA --env development
Copied!
Diffing two versions
Here we can simply use git diff --no-index to use git to compare to files.
1
# --no-index diffs the two folders without regard to their current
2
# status in git
3
git diff --no-index sync-projectA/local sync-projectA/development
Copied!
Examples
Full multi-project enterprise workflow example
This workflow is for enterprise customers who also have a local setup of livingdocs on their machine.
Step 1: Download all configs
1
npx livingdocs-cli project-config:download --format json -p projectA --env dev &&
2
npx livingdocs-cli project-config:download --format json -p projectA --env staging &&
3
npx livingdocs-cli project-config:download --format json -p projectA --env production
4
​
5
npx livingdocs-cli project-config:download --format json -p projectB --env dev &&
6
npx livingdocs-cli project-config:download --format json -p projectB --env staging &&
7
npx livingdocs-cli project-config:download --format json -p projectB --env production
Copied!
Step 2: Commit these changes
Step 3: Download local configs (these usually have the latest changes)
1
npx livingdocs-cli project-config:download --format json -p projectA --env local
2
npx livingdocs-cli project-config:download --format json -p projectB --env local
Copied!
Step 4: Compare configs
One example:
1
git diff --no-index sync-projectA/local sync-projectA/development
Copied!
Note that some configs like renditions or preview urls are always different between environments.
Step 5: Make changes to config files
Step 6: Publish changed configs
One example:
1
# plan update and verify only the expected properties are updated
2
npx livingdocs-cli project-config:plan -p projectA --env development
3
​
4
# if everything looks ok, do the update
5
npx livingdocs-cli project-config:publish -p projectA --env development
Copied!
Step 7: Discard sync-projectA/local and sync-projectB/local
Step 8: Commit the rest

Guides - Previous

DPA Import

Next - CLI

.livingdocs-cli

Last modified 1yr ago

Copy link

Contents

What are we doing here?

Set up CLI environment variables

Commands you can use to sync configs

Download project config

Publish changes

Diffing two versions

Examples

Full multi-project enterprise workflow example