Skip to content

Latest commit

 

History

History
105 lines (79 loc) · 3.46 KB

README.md

File metadata and controls

105 lines (79 loc) · 3.46 KB
Raw

Gradle Yaml Secrets Plugin

This plugin loads properties from Yaml secret files. Properties can later be used in build scripts.

Requirements

  • JRE 8 or higher

How to use

  1. Apply a plugin to a project as described on gradle portal.
  2. Add sample secrets template file in project directory. File must have .sec.yml or .sec.yaml extension, for example testSecrets.sec.yml:
# obligatory value, must be fill in `.testSecrets.sec.yml` file
secretProp: <TO_BE_FILLED>
# property with default value
testProp2: 7
envVars: # fill envVars
args: # fill args list
  1. Refresh project to create .testSecrets.sec.yml file.
  2. Fill necessary properties in .testSecrets.sec.yml file. 
    secretProp: secretValue
testProp2: 7
envVars:
    ENV_VAR_1: testEnvVar
    ENV_VAR_2: 200
args: 
    - 1
    - 2
    - 3
  3. Query loaded properties by the following ways: 
    (...)
val secretProp = secrets.get<String>("testSecrets.secretProp")
println(secretProp)
// produces: "secretValue"

// the same can be done by passing secret name as a separate parameter:
val secretProp = secrets.get<String>("testSecrets", "secretProp")
println(secretProp)
// produces: "secretValue"

val queriedValue = secrets.get<Int>("testSecrets.testProp2")
println(queriedValue)
// produces: "7"

val queriedMap = secrets.get<Map<String,*>>("testSecrets.envVars")
println(queriedMap)
// produces: "{ENV_VAR_1=testEnvVar, ENV_VAR_2=200}"

val queriedList = secrets.get<List<String>>("testSecrets.args")
println(queriedList)
// produces: "[1, 2, 3]"

val queriedListElement = secrets.get<Int>("testSecrets.args[2]")
println(queriedListElement)
// produces: "3"

val secretsData = secrets.getSecretsData("testSecrets")
println(secretsData)
// produces: "YamlSecretsData(secretsName=testSecrets, templateFile=<sample_path>\testSecrets.sec.yml, propertiesFile=<samplePath>\.testSecrets.sec.yml, properties={secretProp=secretValue (...)})"

(...)

Check out examples directory to find sample projects.

Environment variables support

This plugin supports getting a property with environment variables. It can be helpful In case of continuous integration builds where secrets files are unable to be filled.

By default, it checks if there is an environment variable present by converting full property name to SNAKE_CASE environment variable name e.g.

When getting a secret property by the following line:

val secretProperty = secrets.get<String>("testSecrets.secretProp")

Even though testSecrets secrets file can not be present, plugin firstly checks if there is an TESTSECRETS_SECRETPROP environment variable present, if it is, then value from env is assigned to a secretProperty.

It is also possible to specify custom environment variable name:

val secretProperty = secrets.get<String>("testSecrets", "secretProp", "CUSTOM_ENV_VAR_NAME")

In this case we are checking presence of CUSTOM_ENV_VAR_NAME environment variable name instead. If this variable value is not null, then it is assigned to secretProperty.

Notes

  • plugin automatically adds secret files pattern to .gitignore if this file exists in root dir.
  • secret files with the same name can be overridden in child projects (overriding single Yaml properties is not supported)