Parameters
Last updated
Was this helpful?
Last updated
Was this helpful?
Parameters allow a user to provide inputs to the Application Template used to customize an environment or runnable job at creation time.
Parameters are defined in your app template using the top-level parameters
stanza.
For example:
Parameters require a name
, type
, and description
.
For a complete list of available parameter types, see the .
To provide a default value for a parameter:
To declare a parameter as optional, set optional: true
:
An optional parameter's value will be null
or an empty string dependending on where it's referenced.
If a parameter is infrequently used or is only used in very specific cases, you can mark the parmeter as advanced: true
. Advanced parameters are rendered in the "Advanced" section of our UI and are hidden by default.
An optional parameter's value will be null
or an empty string dependending on where it's referenced.
Parameters can be referenced from most places in your Application Template using this syntax: ${parameters.my_parameter_name}
. Here are some common example use cases.
Injecting a parameter values into environment variables:
Injecting a parameter values into resource limits:
This allows dynamically picking a file or Git repository that can be accessible from a known location from within your containers.
Example:
This will show a Git repository picker and a file upload picker in the UI when creating a job or environment for this application allowing the user to customize which code or data is made available to the job.
string
To define a single line string input:
text
To define a multiline text parameter:
boolean
To define a boolean checkbox parameter:
The values when interpolated as a string (i.e. in an environment variable) will be either true
or false
.
git-repo
To define a Git repository picker parameter:
Git repo parameters are also usable from workspace mounts.
git-ref
To define a Git ref picker parameter:
This is similar to git-repo
but instead of using the repository's default branch, it allows the user to select a specific branch, tag, or commit.
Git ref parameters are also usable from workspace mounts.
file
To define a file picker parameter:
This will allow the user to either upload a new file or choose an previously uploaded file.
File parameters are also usable from workspace mounts.
Parameters are designed to work well with . For example the git-ref
, git-repo
, and file
parameter types all produce result in values that can be referenced directly from a workspace mount.
This will only allow selecting a repository that has been registered with Release. See for more details.