diff --git a/README.md b/README.md index de338ea..cabd2da 100644 --- a/README.md +++ b/README.md @@ -171,3 +171,8 @@ Create a credential with **secret file** type. Add credential parameter to job w SecretConfigPath = credentials("${env.SecretConfig}") } ``` + +Articles +-------- + +[Config Transformations](docs/ConfigTransformations.md) diff --git a/docs/ConfigTransformations.md b/docs/ConfigTransformations.md new file mode 100644 index 0000000..49166a5 --- /dev/null +++ b/docs/ConfigTransformations.md @@ -0,0 +1,40 @@ +Config Transformations +====================== + +Development +----------- + +### First Development Build + +Actor | Action +--------------------- | ---------------------------------------------------------------- +Developer | Copy Config.Development.ps1.template to Config.Development.ps1. +Developer | Modify properties in Config.Development.ps1. +Developer | Execute `psake build`. +copy-configs (psake) | Copy appsettings.Development.json.template to appsettings.Development.json. +copy-configs (psake) | Replace variable placeholders with values in appsettings.Development.json. + +### Second Development Build + +Actor | Action +--------------------- | ---------------------------------------------------------------- +Developer | Execute `psake build` or run project in Visual Studio. + +### Change Development Setting + +Actor | Action +--------------------- | ---------------------------------------------------------------- +Developer | Modify settings in appsettings.Development.json. +Developer | Execute `psake build` or run project in Visual Studio. + +Production +---------- + +Actor | Action +---------------------- | ---------------------------------------------------------------- +Jenkins | Set `Environment` and `SecretConfigPath` environment variables. +Jenkins | Execute `psake clean`. +clean (psake) | Revert all changes in working copy. +Jenkins | Execute `psake publish-web`. +copy-configs (psake) | Replace variable placeholders with values in appsettings.Production.json. +update-version (psake) | Replace Version and AssemblyVersion values in project file.