leadent-config-manager
v0.1.9
Published
Leadent Config Manager CLI
Downloads
194
Readme
Leadent Config Manager
L.C.M. has two main uses:
- Fetch and merge config for local testing or deployment
- Diff local config changes to create files to be added to the config repo
1. Fetch and merge configuration files
USAGE
$ leadent-config-manager setup <frontend | portal> [-b <value>] -c <value> -e <value> [-i <value>] [-l <value>]
FLAGS
-b, --branch=<value> all-configs branch name to fetch the config files from, this will default to 'main' if not provided
-c, --client=<value> (required) Client name (folder name in the config repo)
-e, --environment=<value> (required) Target environment (e.g.: dev, local, staging, production)
-i, --inherit=<value> An environment to be merged with the base file before merging with the target environment
-l, --developer=<value> Local developer's settings (merge settings in 'local' folder in all-configs)
-r, --reset=<value> Reset local changes before merging in configuration, the value is the branch name in omw-fe or portal to reset to
DESCRIPTION
When merging in configuration, the config is fetched and merged into the existing configuration in the following order:
1. --reset
2. --inherit
3. --environment
4. --local
EXAMPLES
To merge customer specific configuration
$ leadent-config-manager setup frontend -c client1 -e production
To merge configuration from a different config branch
$ leadent-config-manager setup frontend -c client1 -e production -b all-config-branch
To merge configuration with an inherited environment
$ leadent-config-manager setup frontend -c client1 -i production -e staging
To configuration with a specific developer's settings
$ leadent-config-manager setup frontend -c client1 -i production -l dev1
To merge customer specific configuration with an developer settings
$ leadent-config-manager setup frontend -c client1 -l dev1
To merge reset any local config changes before merging in configuration
$ leadent-config-manager setup frontend -c client1 -i production -l dev1 -r omw-fe-branch
A full example
$ leadent-config-manager setup frontend -r omw-fe-branch -b all-config-branch -c client1 -i production -e staging -l dev1
2. Diffing configuration files
USAGE
$ leadent-config-manager diff frontend -d <value> [-b <value>]
FLAGS
-b, --branch=<value> all-configs branch name to fetch the config files from, this will default to 'main' if not provided
-d, --diff=<value> Branch name to diff against, this will default to 'primary' if not provided
DESCRIPTION
This creates a diff your local configuration compared to the omw-fe or portal branch provided.
This could then be added to all-configs.
EXAMPLES
$ leadent-config-manager diff frontend
$ leadent-config-manager diff frontend -d some-new-omw-fe-branch