☁️ Loving our new documentation website? Provide feedback in the CloudCannon Community! ✨

extra_data

Table of contents

Description:

This key defines additional template strings for building nested templates.

The value is an object that can contain any properties. Each property value can be any data type and specifies additional data to include in commit message templates.

Appears in:
└── commit_templates
    └── [*]
        └── extra_data
Type:
Object<extra_data.*>
Values:
*string#

This key represents an individual extra data property in the commit_templates.[*].extra_data object.

The value can be any data type and specifies additional data to include in commit message templates.

Show examplesHide examples

In this example, we have configured an extra data property breaking_change with a template string.

Copied to clipboard
commit_templates:
  - label: Breaking change
    template_string: '{message}{breaking_change|if=breaking_change_message}'
    _inputs:
      breaking_change_message:
        type: text
    extra_data:
      breaking_change: ⚠️ {breaking_change_message}
{
  "commit_templates": [
    {
      "label": "Breaking change",
      "template_string": "{message}{breaking_change|if=breaking_change_message}",
      "_inputs": {
        "breaking_change_message": {
          "type": "text"
        }
      },
      "extra_data": {
        "breaking_change": "⚠️ {breaking_change_message}"
      }
    }
  ]
}
Examples:

In this example, we have configured a commit template with extra data to include a breaking change message.

Copied to clipboard
commit_templates:
  - label: Breaking change
    template_string: '{message}{breaking_change|if=breaking_change_message}'
    _inputs:
      breaking_change_message:
        type: text
    extra_data:
      breaking_change: ⚠️ {breaking_change_message}
{
  "commit_templates": [
    {
      "label": "Breaking change",
      "template_string": "{message}{breaking_change|if=breaking_change_message}",
      "_inputs": {
        "breaking_change_message": {
          "type": "text"
        }
      },
      "extra_data": {
        "breaking_change": "⚠️ {breaking_change_message}"
      }
    }
  ]
}
Open in a new tab