ensure_env_vars
Raises an exception if the specified env vars are not set
| ensure_env_vars | |
|---|---|
| Supported platforms | mac, linux, windows |
| Author | @johnknapprs |
1 Example
ensure_env_vars( vars: ['GITHUB_USER_NAME', 'GITHUB_API_TOKEN'] )
Parameters
| Key | Description | Default |
|---|---|---|
vars |
The ENV variables keys to verify |
* = default value is dependent on the user's system
Documentation
To show the documentation in your terminal, run
pantograph action ensure_env_vars
CLI
It is recommended to add the above action into your Pantfile, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
pantograph run ensure_env_vars
To pass parameters, make use of the : symbol, for example
pantograph run ensure_env_vars parameter1:"value1" parameter2:"value2"
It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. param:"1,2,3"). Hashes are not currently supported.
It is recommended to add all pantograph actions you use to your Pantfile.
Source code
This action, just like the rest of pantograph, is fully open source, view the source code on GitHub