Customizing the bitrise.yml config
Any tool that can edit bitrise.yml can add custom properties to it. This way you can add special properties or notes to your env vars, or even try new configurations of your Workflow in bitrise.yml. All you have to add is add a meta field and
a namespace label with key and value to the right place.
Any tool that can edit bitrise.yml can add custom properties to it. This way
you can add special properties or notes to your Env Vars, or even try new configurations of your Workflow in bitrise.yml. All you have to add is add a meta field and a namespace label with key and value to the right place.
Use the following format to add custom values to your configuration:
KEY: "VALUE",
opts: {
title: "My env var"
description: "Description of my env var."
summary: "Summary of env var."
...
meta: {
custom_namespace_id_1: {
key1: "value1",
key2: "value2",
...
}
custom_namespace_id_2: {
...
}
}
You can fork our Workflow Editor and use your own version of it. Then you can use meta: for example, let's say you want to keep an eye on one of the Environment Variables (Env Var), you want to know when it was last modified and by who.
app:
envs:
- ASXaS: "`ZX`ZX"
opts:
is_expand: false
meta:
audit: # used by the Audited Workflow Editor imaginary tool: that works like the WFE but it also saves the modifier and modification date, and displays it
last_modified_at: 2018.09.12.
last_modifier: Jane Doe
You can use meta to add background color to an env var in your own tool:
meta: {
my_fancy_new_workflow_editor: {
env_var_background_color: "red"
}
}
You can see meta in action on bitrise.io as well. For example, when you select a different stack for your Workflow than the default stack. Just click Workflow Editor on the UI and pick another stack type for your
Workflow/s on the Stacks & Machines tab. This way you can test how your Workflow runs in the new Stack.
If you head back to the bitrise.yml tab, a bitrise.io meta is added to the deploy Workflow:
workflows:
deploy:
steps:
- [email protected]:
run_if: '{{getenv "SSH_RSA_PRIVATE_KEY" | ne ""}}'
- [email protected]: {}
- [email protected]:
title: Do anything with Script step
- [email protected]: {}
meta:
bitrise.io:
stack: osx-xcode-12.1.x
Since this meta is only interpreted on bitrise.io and not locally or on the Bitrise CLI, it is categorized by a bitrise.io namespace (where the stack is the key and osx-xcode-12.1.x is the
value). The Workflow Editor always validates the saved variable and throws an error if there is a syntax error, but with meta added, its content is fully ignored by the Workflow Editor validation process.