rozehnal/environment-parameters

Composer script building your detached parameters for deploying the app. Built above the great incenteev/composer-parameter-handler library.

Composer script building your detached parameters for deploying your app

This tool allows you to manage app parameters for deployment in separate repositories. The repo is fully compatible with all parameters from https://github.com/Incenteev/ParameterHandler., _(*1)

, _(*2)

Run

composer run-script build --no-interaction -- --env=prod, _(*3)

Usage

Add the following in your root composer.json file:, _(*4)

{
    "require": {
        "rozehnal/environment-parameters": "0.x-dev"
    },
    "scripts": {
       "build": [
             "Paro\\EnvironmentParameters\\ParametersHandler::buildParameters"
           ]
    },
    "extra": {
        "environment-parameters": {
          "build-folder": "build",
          "files": [
            {
              "file": "{env}/key.{env}.p12",
              "name": "key.p12"
            }
          ],
          "incenteev-parameters": {
            "file": "parameters.yml",
            "env-map": {
              "path": "PATH"
            }
          }
        }
      }
}

The build/parameters.yml will then be created composer script, to match the structure of the dist file parameters.yml by asking you the missing parameters., _(*5)

Supported syntax

• Fully compatible with https://github.com/Incenteev/ParameterHandler
• "%env(ENV_VARIABLE)%" syntax in *.yml files
• imports in *.yml files

 imports:
     - { resource: 'include.yml' }

Hierarchical structure

{
    "extra": {
        "environment-parameters": {
          "files": [
            {
              "file": "{env}/key.p12",
              "name": "key.p12"
            }
          ],
          "incenteev-parameters": {
            "file": "{env}/parameters.yml"
          }
        }
    }
}

composer run-script build --no-interaction -- --env=test/test01, _(*6)

Files are searched in order test/test01/key.p12, test/key.p12 and test/test01/parameters.yml, test/parameters.yml. It means you are able to build configuration on inheritence from parent folders with overriding details in children folders. Applicable for both - files and *.yml files., _(*7)

Output formats [yaml, php-constants]

Default output format is well-knownyaml file. Currently there is possible to create php file where each parameter defines constant - define(key, value)., _(*8)

{
    "extra": {
        "environment-parameters": {
          "incenteev-parameters": {
            "file": "{env}/parameters.yml",
            "name": "parameters.php",
            "output-format": "php-constants"
          }
        }
    }
}

Example

https://github.com/rozehnal/environment-parameters-test, _(*9)

Todo