Customizing your configuration YAML

Any tool that can edit a configuration YAML file 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. 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: {
      ...
    }
}

 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

 meta: {
   my_fancy_new_workflow_editor: {
     env_var_background_color: "red"
   }
 }

When you change the stack configuration on the Workflow Editor UI, you modify metaunder the hood. In this example, the deploy Workflow is configured to run on Xcode 16.1.

workflows:
  deploy:
    steps:
    - activate-ssh-key@4:
        run_if: '{{getenv "SSH_RSA_PRIVATE_KEY" | ne ""}}'
    - git-clone@4: {}
    - script@1:
        title: Do anything with Script step
    - deploy-to-bitrise-io@1: {}
    meta:
      bitrise.io:
        stack: osx-xcode-16.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.