gradle-plugin

Chamaleon Gradle Plugin

Simplify the management of multiple environments for any Kotlin project

Features

• Define multiple environments and switch between them
• Keep the same structure of all your environments
• Kotlin multiplatform support in mind from the creation

Quick start

1. Apply the plugin in your build.gradle.kts file

plugins {
    id("io.github.gerardorodriguezdev.chamaleon") version "1.0.1" // check the latest version
}

This plugin is hosted on the Gradle Plugins Portal

2. Create the configuration files

Create a directory named environments in the root of your project. Inside this directory, create the following files:

myProject
    environments
        cha.json
        development-cha.json

You can see a sample on Sample Gradle Project

3. Fill the cha.json

This is the file that will be used to validate all the environment json files follow this structure

{
  "supportedPlatforms": [
    "android"
  ],
  "propertyDefinitions": [
    {
      "name": "HOST",
      "propertyType": "String",
      "nullable": false
    }
  ]
}

• supportedPlatforms: Can be any or all of this android, wasm, jvm or ios
• propertyDefinitions: It's an array of property definition
  • propertyDefinition:
    • name: The name of your property (cannot be an empty string) -> required
    • propertyType: Can be String or Boolean -> required
    • nullable: If the property is nullable or not (default=false)-> optional

4. Fill the development-cha.json

Any json file named anything-cha.json inside the environments directory will be considered an environment. You can as many as you want with like local-cha.json or production-cha.json. For now, we added development-cha.json. Let's add this content to it:

[
  {
    "platformType": "android",
    "properties": [
      {
        "name": "HOST",
        "value": "localhost"
      }
    ]
  }
]

• platformType: Can be any or all of this android, wasm, jvm or ios
• properties: It's an array of property
  • property:
    • name: The name of your property (cannot be an empty string) required
    • value: The value of your property. Can be String, Boolean or null optional if it's nullable

Using the plugin

Now that you have applied the plugin and added the required files you should be able to do this on the build.gradle.kts

plugins {
    //... your plugins and the chamaleon plugin you applied before ^^^
}

chamaleon.environments // The environments are parsed and you can read the properties per environment and/or per platform

Selecting an environment

If you want to set an environment as the selected one, you can do it by adding cha.properties file in environments with this content:

CHAMALEON_SELECTED_ENVIRONMENT=development-cha

If you have a production-cha.json and want to test locally but avoid commiting it just add production-cha.json to your .gitignore file

Using the json schemas

The json schemas for cha.json and yourenvironments-cha.json have been uploaded to Schema store so you can see hints if the schema is valid or not. Alternatively you can find them here Schemas