releasehx 0.1.0

data/lib/releasehx/mcp/assets/config-reference.json

@@ -0,0 +1,1546 @@
+{
+  "format": "releasehx-config-reference",
+  "version": 1,
+  "properties": {
+    "$meta": {
+      "path": "$meta",
+      "desc": "The metadata settings for the configuration file.\n",
+      "properties": {
+        "markup": {
+          "path": "$meta.markup",
+          "desc": "The markup format used in strings in this configuration file.\nMay be `asciidoc` or `markdown`.\n\nThis probably matters less than you might imagine, as ReleaseHx will use AsciiDoc-style `+++_italic_+++` and `+++*bold*+++` syntax, and there should not be much call for divergent syntax like for links or images.\nAll default values are cross-compatible.\n",
+          "type": "String",
+          "default": "markdown"
+        },
+        "slug_type": {
+          "path": "$meta.slug_type",
+          "desc": "The format of slugs used in your application, for use with `sluggerize` Liquid filter.\n\nMust be `kebab` (ex: `hyphen-delimited-slug`) or `snake` (ex: `underscore_delimited_slug`).\n",
+          "type": "String",
+          "default": "kebab"
+        },
+        "tplt_lang": {
+          "path": "$meta.tplt_lang",
+          "desc": "The default format used in fields of `Template` type.\nMust be `liquid` or `erb`.\n",
+          "type": "String",
+          "default": "liquid"
+        }
+      }
+    },
+    "origin": {
+      "path": "origin",
+      "desc": "The API or file source for the issues.\n",
+      "properties": {
+        "source": {
+          "path": "origin.source",
+          "desc": "The type of API or file to use for the issues source.\nMay be `jira`, `github`, `gitlab`, or `rhyml`.\n",
+          "docs": "The `jira`, `github`, and `gitlab` types are all REST APIs that return an individualized JSON payload upon request, to be converted to RHYML format.\n\nAlternately, you may use a file directly written in <<rhyml,RHYML-style YAML>> (`rhyml`).\n\nIf you wish to mix Git and API sources, this field should still reference the API.\n\nCustom APIs are also available, but you will need to create a custom client in the `_apis` directory (<<conf_ppty_paths_api_clients_dir>>), and a custom mapping in the `_mappings` directory (<<conf_ppty_paths_mappings_dir).\n",
+          "type": "String",
+          "default": "rhyml"
+        },
+        "project": {
+          "path": "origin.project",
+          "desc": "The string used to identify the project in the remote API.\nOnly required if the API requires a project identifier.\n",
+          "type": "Slug"
+        },
+        "href": {
+          "path": "origin.href",
+          "desc": "The local or remote URI for the API or JSON file.\nEither the REST API endpoint path or the path to a local or remote JSON file containing the issues data.\n\nThis field may be templated, accepting Liquid placeholders like `{{ proj }}` (the sibling `project` property) or `{{ version }}` (the argued release version code).\n",
+          "type": "URI",
+          "templating": {
+            "delay": false
+          }
+        },
+        "auth": {
+          "path": "origin.auth",
+          "desc": "Properties related to API authentication.\n\nThis block should be unnecessary if you use a supported API (Jira, GitHub, GitLab), unless you wish to use differently named environment variables for API credentials.\n",
+          "properties": {
+            "mode": {
+              "path": "origin.auth.mode",
+              "desc": "The type of authentication to use.\n\nOptions are: `basic`, `token`, `bearer`, `header`, `query`, `none`.\n"
+            },
+            "header": {
+              "path": "origin.auth.header",
+              "desc": "The header to use for authentication.\nOnly used if `origin.auth.mode` is `header`.\n",
+              "type": "String"
+            },
+            "cred_uri": {
+              "path": "origin.auth.cred_uri",
+              "desc": "The location of the API credentials file for declaring API authentication arguments without environment variables.\n\nThe value can be a local path with read access or an HTTP path (not recommended unless ReleaseHx is always executed on an organizational VPN).\n",
+              "docs": "The default order of credential strings defaults to:\n\n....\nAPI_KEY\nUSERNAME\nORGANIZATION\n....\n\nHowever, this format can be customized using <<conf_ppty_cred_key_line>>, <<conf_ppty_cred_user_line>>, and <<conf_ppty_cred_org_line>>.\n\nNote that each of these lines can be overridden with an environment variable: <<conf_ppty_origin_auth_key_env>>, <<conf_ppty_origin_auth_user_env>>, and <<conf_ppty_origin_auth_org_env>>.\n\n[IMPORTANT]\nThis file should probably be added to `.gitignore` in your application repo.\n",
+              "type": "URI",
+              "default": "RELEASEHX_API_CRED"
+            },
+            "cred_key_line": {
+              "path": "origin.auth.cred_key_line",
+              "desc": "Number of the line of the credentials file (at <<conf_ppty_origin_auth_cred_uri>>) on which the key or token string appears.\n",
+              "type": "Number",
+              "default": 1
+            },
+            "cred_user_line": {
+              "path": "origin.auth.cred_user_line",
+              "desc": "Number of the line of the credentials file (at <<conf_ppty_origin_auth_cred_uri>>) on which the user string appears.\n",
+              "type": "Number",
+              "default": 2
+            },
+            "cred_org_line": {
+              "path": "origin.auth.cred_org_line",
+              "desc": "Number of the line of the credentials file (at <<conf_ppty_origin_auth_cred_uri>>) on which the org string appears.\n",
+              "type": "Number",
+              "default": 3
+            },
+            "key_env": {
+              "path": "origin.auth.key_env",
+              "desc": "Name of the environment variable containing the API key or token.\nWill override the key line in an existing credentials file (see <<conf_ppty_origin_auth_cred_uri>>).\n",
+              "type": "String",
+              "default": "RELEASEHX_API_KEY"
+            },
+            "user_env": {
+              "path": "origin.auth.user_env",
+              "desc": "Name of the environment variable containing the API username.\nWill override the user line in an existing credentials file (see <<conf_ppty_origin_auth_cred_uri>>).\n",
+              "type": "String",
+              "default": "RELEASEHX_API_USER"
+            },
+            "org_env": {
+              "path": "origin.auth.org_env",
+              "desc": "Name of the environment variable containing the organization credential.\nWill override the org line in an existing credentials file (see <<conf_ppty_origin_auth_cred_uri>>).\n",
+              "type": "String",
+              "default": "RELEASEHX_API_ORG"
+            }
+          }
+        }
+      }
+    },
+    "conversions": {
+      "path": "conversions",
+      "desc": "Details about content origination, as well as markup sources and conversion.\nUsed to assist mapping between API source payloads and the corresponding properties of their target RHYML _change_ records.\n",
+      "properties": {
+        "summ": {
+          "path": "conversions.summ",
+          "desc": "The source of the summary (Changelog) content.\nMust be `issue_heading`, `custom_field`, or `commit_message_heading`.\n\nIf `issue_heading`, the summary or title field will be used.\nIf `commit_message_heading`, the first line of the Git commit will be used.\n",
+          "type": "String",
+          "default": "issue"
+        },
+        "head": {
+          "path": "conversions.head",
+          "desc": "The source of release-note headlines, when it is not the same as the summary.\n\nUnless a `head` is available in the RHYML source, the `summ` will be used.\nBy default, ReleaseHx does not generate a `head` property for work items.\n\nPotential values: `issue_heading`, `release_note_heading`, or `commit_message_heading`.\n",
+          "docs": "When set to *`issue_heading`*, the RHYML `head` property will derive from the issue title or summary.\n\nWhen set to *`release_note_heading`* or *`commit_message_heading`*, the `head` property will derive from the first line of the release note or commit message, respectively, so long as it matches the Regular Expression set in `ppty.release_note_heading_pattern`.\nWhen set to `commit_message_heading`, the RHYML `head` property will derive from the first line of the commit message.\n",
+          "type": "String"
+        },
+        "note": {
+          "path": "conversions.note",
+          "desc": "The source of the release notes content.\nMust be `issue_body`, `custom_field`, or `commit_message`.\n\nDefaults to `issue_body` for GitHub and GitLab, but to `custom_field` for Jira.\n",
+          "type": "String"
+        },
+        "note_custom_field": {
+          "path": "conversions.note_custom_field",
+          "desc": "The name of the custom field to use for the release notes content.\nOnly used if `conversions.note` is `custom_field`.\n\nThis purposely has no default, as you will probably have to look up the actual field ID, which will be something like `customfield_10010`.\n",
+          "type": "String"
+        },
+        "note_pattern": {
+          "path": "conversions.note_pattern",
+          "desc": "The Regular Expressions pattern to match in the body of an issue or commit message, after which all content is considered the release `note` matter.\n\nDefaults to a Markdown or AsciiDoc header or HTML comment with the case-insensitive string `release note` in it.\n\nUses Capture group `note` in the Regular Expression to establish the entire note content.\n\nSee the `conversions.head_pattern` property for details on extracting a heading (`head` in RHYML) from the `note` content.\n",
+          "type": "RegExp",
+          "default": "/^((#|=)+ (Draft )?Release Note.*)|(<!-- (draft )?release note -->)\\n(?<note>\\w(.|\\n)+)/gmi"
+        },
+        "head_pattern": {
+          "path": "conversions.head_pattern",
+          "desc": "The Regular Expressions pattern to match in the `note` text to be used to establish a heading for the note (`head`).\nThis text is removed from the `note` value during a draft operation, if the pattern matches.\n\nDefaults to a Markdown or AsciiDoc header or HTML comment with the case-insensitive string `release note` in it.\n\nThe `head` capture group is snipped from text matching this pattern.\n",
+          "type": "RegExp",
+          "default": "/^(?<head>[A-Z].*[^.!])\\n\\n[A-Z].*/gm"
+        },
+        "markup": {
+          "path": "conversions.markup",
+          "desc": "The origin markup format for notes.\nMay be `markdown` or `asciidoc`.\n",
+          "type": "String",
+          "default": "markdown"
+        },
+        "engine": {
+          "path": "conversions.engine",
+          "desc": "The markup converter to use for the issues.\nDefaults to `asciidoctor` for AsciiDoc and `redcarpet` for Markdown.\nOptions include `asciidoctor`, `redcarpet`, `commonmarker`, `kramdown`, or `pandoc`.\n",
+          "type": "String"
+        }
+      }
+    },
+    "extensions": {
+      "path": "extensions",
+      "desc": "Default file extensions.",
+      "properties": {
+        "markdown": {
+          "path": "extensions.markdown",
+          "desc": "File extension for Markdown drafts.",
+          "type": "String",
+          "default": "md"
+        },
+        "asciidoc": {
+          "path": "extensions.asciidoc",
+          "desc": "File extension for AsciiDoc drafts.",
+          "type": "String",
+          "default": "adoc"
+        },
+        "yaml": {
+          "path": "extensions.yaml",
+          "desc": "File extension for YAML drafts.",
+          "type": "String",
+          "default": "yml"
+        }
+      }
+    },
+    "types": {
+      "path": "types",
+      "desc": "Issue types to include in the release history, in the order of display.\n\nList as many as you wish to match up with corresponding metadata at the source.\n",
+      "type": "Map",
+      "properties": {
+        "label_prefix": {
+          "path": "types.label_prefix",
+          "desc": "The prefix used in issue labels to identify type labels.\nFor example, 'type:' would match labels like 'type:feature', 'type:bug'.\nAnother common pattern is 'kind:' for labels like 'kind:feature', 'kind:enhancement'.\n\nIf set to an empty string or null, type detection will only look for direct label matches\nagainst the configured type slugs (e.g., looking for 'bug', 'feature' labels directly).\n",
+          "docs": "This setting allows you to customize how your organization names type labels.\nThe mapping system will look for labels that start with this prefix to determine the type of each change.\n\nExamples:\n\n* `type:` matches `type:feature`, `type:bug`\n* `kind:` matches `kind:enhancement`, `kind:defect` \n* `category-` matches `category-feature`, `category-bugfix`\n\nWhen no prefix is configured (empty string), the system will look for labels that directly match\nthe `slug` property of each configured type.\n",
+          "type": "String",
+          "default": ""
+        },
+        "feature": {
+          "path": "types.feature",
+          "desc": "A new capability, functionality, or interface element.\n",
+          "properties": {
+            "slug": {
+              "path": "types.feature.slug",
+              "desc": "The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.\n",
+              "type": "String",
+              "default": "feature"
+            },
+            "text": {
+              "path": "types.feature.text",
+              "desc": "The display label for the type in the release history output.\nDefaults to the capitalized key name.\n",
+              "type": "String",
+              "default": "New feature"
+            },
+            "head": {
+              "path": "types.feature.head",
+              "desc": "The header for the type in the release history output.\nDefaults in templates to the `text` property pluralized.\n",
+              "type": "String",
+              "default": "New features"
+            },
+            "icon": {
+              "path": "types.feature.icon",
+              "desc": "The icon to use for issues of this type.\n",
+              "type": "String",
+              "default": "plus-square-o"
+            }
+          }
+        },
+        "bug": {
+          "path": "types.bug",
+          "desc": "A fix for a previously reported issue.\n",
+          "properties": {
+            "slug": {
+              "path": "types.bug.slug",
+              "desc": "The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.\n",
+              "type": "String",
+              "default": "bug"
+            },
+            "text": {
+              "path": "types.bug.text",
+              "desc": "The display label for the type in the release history output.\nDefaults to the capitalized key name.\n",
+              "type": "String",
+              "default": "Bug fix"
+            },
+            "head": {
+              "path": "types.bug.head",
+              "desc": "The header for the type in the release history output.\nDefaults in templates to the `text` property pluralized.\n",
+              "type": "String",
+              "default": "Bug fixes"
+            },
+            "icon": {
+              "path": "types.bug.icon",
+              "desc": "The icon to use for issues of this type.\n",
+              "type": "String",
+              "default": "bug"
+            }
+          }
+        },
+        "improvement": {
+          "path": "types.improvement",
+          "desc": "An enhancement to an existing capability, functionality, or interface element.\n",
+          "properties": {
+            "slug": {
+              "path": "types.improvement.slug",
+              "desc": "The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.\n",
+              "type": "String",
+              "default": "improvement"
+            },
+            "text": {
+              "path": "types.improvement.text",
+              "desc": "The display label for the type in the release history output.\nDefaults to the capitalized key name.\n",
+              "type": "String",
+              "default": "Improvement"
+            },
+            "head": {
+              "path": "types.improvement.head",
+              "desc": "The header for the type in the release history output.\nDefaults in templates to the `text` property pluralized.\n",
+              "type": "String",
+              "default": "Improvements"
+            },
+            "icon": {
+              "path": "types.improvement.icon",
+              "desc": "The icon to use for issues of this type.\n",
+              "type": "String",
+              "default": "wrench"
+            }
+          }
+        },
+        "documentation": {
+          "path": "types.documentation",
+          "desc": "An update to the documentation.\n",
+          "properties": {
+            "slug": {
+              "path": "types.documentation.slug",
+              "desc": "The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.\n",
+              "type": "String",
+              "default": "documentation"
+            },
+            "text": {
+              "path": "types.documentation.text",
+              "desc": "The display label for the type in the release history output.\nDefaults to the capitalized key name.\n",
+              "type": "String",
+              "default": "Documentation"
+            },
+            "head": {
+              "path": "types.documentation.head",
+              "desc": "The header for the type in the release history output.\nDefaults in templates to the `text` property pluralized.\n",
+              "type": "String",
+              "default": "Docs Changes"
+            },
+            "icon": {
+              "path": "types.documentation.icon",
+              "desc": "The icon to use for issues of this type.\n",
+              "type": "String",
+              "default": "book"
+            }
+          }
+        },
+        "<type_name>": {
+          "path": "types.<type_name>",
+          "desc": "The corresponding issue type.\n\nThe key should be a simple string for referencing the slug in RHYML and ReleaseHx templates.\nThis is what will be entered in a change's `type` property in RHYML.\n",
+          "properties": {
+            "slug": {
+              "path": "types.<type_name>.slug",
+              "desc": "The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.\n",
+              "type": "String"
+            },
+            "text": {
+              "path": "types.<type_name>.text",
+              "desc": "The display label for the type in the release history output.\nDefaults to the capitalized key name.\n",
+              "type": "String"
+            },
+            "head": {
+              "path": "types.<type_name>.head",
+              "desc": "The header for the type in the release history output.\nDefaults in templates to the `text` property pluralized.\n",
+              "type": "String"
+            },
+            "icon": {
+              "path": "types.<type_name>.icon",
+              "desc": "The icon to use for issues of this type.\n",
+              "type": "String"
+            }
+          }
+        }
+      }
+    },
+    "parts": {
+      "path": "parts",
+      "desc": "The map of product components to include in the release history, in the order of display.\n\nList as many as you wish to match up with corresponding metadata at the source.\n",
+      "type": "Map",
+      "properties": {
+        "label_prefix": {
+          "path": "parts.label_prefix",
+          "desc": "The prefix used in issue labels to identify component/part labels.\nFor example, 'part:' would match labels like 'part:frontend', 'part:backend'.\nAnother common pattern is 'component:' for labels like 'component:ui', 'component:api'.\n",
+          "docs": "This setting allows you to customize how your organization names component labels.\nThe mapping system will look for labels that start with this prefix to determine which parts/components are affected by each change.\n\nExamples:\n\n* `part:` matches `part:frontend`, `part:backend`\n* `component:` matches `component:ui`, `component:api`\n* `area-` matches `area-security`, `area-performance`\n",
+          "type": "String",
+          "default": "part:"
+        },
+        "<part_name>": {
+          "path": "parts.<part_name>",
+          "desc": "The corresponding product component.\n\nThe key should be a simple string for referencing the slug in RHYML and ReleaseHx templates.\nThis is what will be entered in a change's `part` property in RHYML.\n",
+          "type": "Map",
+          "properties": {
+            "slug": {
+              "path": "parts.<part_name>.slug",
+              "desc": "The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.\n\n[NOTE]\nThis technically does not have to be a \"`Slug`\" String, if the system permits spaces, colons, etc.\nIt just needs to _exactly_ match whatever String the remote API returns to represent the label/tag.\n",
+              "type": "String"
+            },
+            "text": {
+              "path": "parts.<part_name>.text",
+              "desc": "The display text for the component in the release history output.\nDefaults to the capitalized key name.\n",
+              "type": "String"
+            },
+            "head": {
+              "path": "parts.<part_name>.head",
+              "desc": "The header for the component in the release history output.\nDefaults in templates to the `text` property pluralized.\n",
+              "type": "String"
+            },
+            "icon": {
+              "path": "parts.<part_name>.icon",
+              "desc": "The icon to use for issues that affect this component.\n",
+              "type": "String"
+            }
+          }
+        }
+      }
+    },
+    "tags": {
+      "path": "tags",
+      "desc": "Handling for tags, labels, or toggles associated with source Issues.\n\nSubordinate property keys (other than `include` and `exclude`) represent individual tag names, with the default set documented here.\nThe property `<your_tag_name>` represents arbitrarily named tags, any number of which you are welcome to add.\n\nThis block serves to filter out any unrelated labels/tags ingested from APIs during the conversion from payload to RHYML draft.\nOnly tags with their own property here will be ported from the issue source to the RHYML change record's `tags` Array.\n",
+      "type": "Array",
+      "properties": {
+        "_include": {
+          "path": "tags._include",
+          "desc": "The tags, labels, or toggles that trigger inclusion in the release history.\n",
+          "type": "Array",
+          "default": [
+            "highlight",
+            "deprecation",
+            "removal",
+            "breaking",
+            "experimental",
+            "changelog"
+          ]
+        },
+        "_exclude": {
+          "path": "tags._exclude",
+          "desc": "The list of tags that cause a change/issue to be excluded from the release history.\n",
+          "type": "Array",
+          "default": []
+        },
+        "highlight": {
+          "path": "tags.highlight",
+          "desc": "The tag, label, or toggle that indicates an issue is to be highlighted or prioritized in sorts.",
+          "properties": {
+            "head": {
+              "path": "tags.highlight.head",
+              "desc": "How this tag will display as a grouping title.",
+              "type": "String",
+              "default": "Highlights"
+            },
+            "text": {
+              "path": "tags.highlight.text",
+              "desc": "How this tag will display as a label.",
+              "type": "String",
+              "default": "highlight"
+            },
+            "slug": {
+              "path": "tags.highlight.slug",
+              "desc": "The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.\n\n[NOTE]\nThis technically does not have to be a \"`Slug`\" String, if the system permits spaces.\nIt just needs to exactly match whatever String the remote API returns to represent the label/tag.\n",
+              "type": "String",
+              "default": "highlighted"
+            },
+            "icon": {
+              "path": "tags.highlight.icon",
+              "desc": "The icon to use for issues so-tagged.\n",
+              "type": "String",
+              "default": "star"
+            },
+            "drop": {
+              "path": "tags.highlight.drop",
+              "desc": "Whether to drop this tag when creating a RHYML object from API source.\nBasically decides whether this tag is user-facing.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "groupable": {
+              "path": "tags.highlight.groupable",
+              "desc": "Whether this tag can be used to group issues in the release history.\n",
+              "type": "Boolean",
+              "default": true
+            }
+          }
+        },
+        "breaking": {
+          "path": "tags.breaking",
+          "desc": "The tag, label, or toggle that indicates a potentially disruptive change.",
+          "properties": {
+            "head": {
+              "path": "tags.breaking.head",
+              "desc": "How this tag will display as a grouping title.",
+              "type": "String",
+              "default": "Breaking Changes"
+            },
+            "text": {
+              "path": "tags.breaking.text",
+              "desc": "How this tag will display as a label.",
+              "type": "String",
+              "default": "Breaking"
+            },
+            "slug": {
+              "path": "tags.breaking.slug",
+              "desc": "The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.\n\n[NOTE]\nThis technically does not have to be a \"`Slug`\" String, if the system permits spaces.\nIt just needs to exactly match whatever String the remote API returns to represent the label/tag.\n",
+              "type": "String",
+              "default": "breaking"
+            },
+            "icon": {
+              "path": "tags.breaking.icon",
+              "desc": "The icon to use for issues so-tagged.\n",
+              "type": "String",
+              "default": "exclamation-triangle"
+            },
+            "drop": {
+              "path": "tags.breaking.drop",
+              "desc": "Whether to drop this tag when creating a RHYML object from API source.\nBasically decides whether this tag is user-facing.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "groupable": {
+              "path": "tags.breaking.groupable",
+              "desc": "Whether this tag can be used to group issues in the release history.\n",
+              "type": "Boolean",
+              "default": true
+            }
+          }
+        },
+        "removal": {
+          "path": "tags.removal",
+          "desc": "The tag, label, or toggle that indicates a change includes a feature removal.",
+          "properties": {
+            "head": {
+              "path": "tags.removal.head",
+              "desc": "How this tag will display as a grouping title.",
+              "type": "String",
+              "default": "Feature Removals"
+            },
+            "text": {
+              "path": "tags.removal.text",
+              "desc": "How this tag will display as a label.",
+              "type": "String",
+              "default": "Removed"
+            },
+            "slug": {
+              "path": "tags.removal.slug",
+              "desc": "The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.\n\n[NOTE]\nThis technically does not have to be a \"`Slug`\" String, if the system permits spaces.\nIt just needs to exactly match whatever String the remote API returns to represent the label/tag.\n",
+              "type": "String",
+              "default": "removal"
+            },
+            "icon": {
+              "path": "tags.removal.icon",
+              "desc": "The icon to use for issues so-tagged.\n",
+              "type": "String",
+              "default": "sign-out"
+            },
+            "drop": {
+              "path": "tags.removal.drop",
+              "desc": "Whether to drop this tag when creating a RHYML object from API source.\nBasically decides whether this tag is user-facing.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "groupable": {
+              "path": "tags.removal.groupable",
+              "desc": "Whether this tag can be used to group issues in the release history.\n",
+              "type": "Boolean",
+              "default": true
+            }
+          }
+        },
+        "deprecation": {
+          "path": "tags.deprecation",
+          "desc": "The tag, label, or toggle that indicates an issue includes a feature discontinuation announcement.",
+          "properties": {
+            "head": {
+              "path": "tags.deprecation.head",
+              "desc": "How this tag will display as a grouping title.",
+              "type": "String",
+              "default": "Deprecations"
+            },
+            "text": {
+              "path": "tags.deprecation.text",
+              "desc": "How this tag will display as a label.",
+              "type": "String",
+              "default": "Deprecated"
+            },
+            "slug": {
+              "path": "tags.deprecation.slug",
+              "desc": "The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.\n\n[NOTE]\nThis technically does not have to be a \"`Slug`\" String, if the system permits spaces.\nIt just needs to exactly match whatever String the remote API returns to represent the label/tag.\n",
+              "type": "String",
+              "default": "deprecation"
+            },
+            "icon": {
+              "path": "tags.deprecation.icon",
+              "desc": "The icon to use for issues so-tagged.\n",
+              "type": "String",
+              "default": "exclamation-triangle"
+            },
+            "drop": {
+              "path": "tags.deprecation.drop",
+              "desc": "Whether to drop this tag when creating a RHYML object from API source.\nBasically decides whether this tag is user-facing.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "groupable": {
+              "path": "tags.deprecation.groupable",
+              "desc": "Whether this tag can be used to group issues in the release history.\n",
+              "type": "Boolean",
+              "default": true
+            }
+          }
+        },
+        "security": {
+          "path": "tags.security",
+          "desc": "The tag, label, or toggle that indicates a change includes a security-related alteration.\n",
+          "properties": {
+            "head": {
+              "path": "tags.security.head",
+              "desc": "How this tag will display as a grouping title.",
+              "type": "String",
+              "default": "Security Fixes"
+            },
+            "text": {
+              "path": "tags.security.text",
+              "desc": "How this tag will display as a label.",
+              "type": "String",
+              "default": "Security"
+            },
+            "slug": {
+              "path": "tags.security.slug",
+              "desc": "The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.\n\n[NOTE]\nThis technically does not have to be a \"`Slug`\" String, if the system permits spaces.\nIt just needs to exactly match whatever String the remote API returns to represent the label/tag.\n",
+              "type": "String",
+              "default": "security"
+            },
+            "icon": {
+              "path": "tags.security.icon",
+              "desc": "The icon to use for issues so-tagged.\n",
+              "type": "String",
+              "default": "shield"
+            },
+            "drop": {
+              "path": "tags.security.drop",
+              "desc": "Whether to drop this tag when creating a RHYML object from API source.\nBasically decides whether this tag is user-facing.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "groupable": {
+              "path": "tags.security.groupable",
+              "desc": "Whether this tag can be used to group issues in the release history.\n",
+              "type": "Boolean",
+              "default": true
+            }
+          }
+        },
+        "experimental": {
+          "path": "tags.experimental",
+          "desc": "The tag, label, or toggle that indicates a feature that is not yet stable or may not be permanent.",
+          "properties": {
+            "head": {
+              "path": "tags.experimental.head",
+              "desc": "How this tag will display as a grouping title.",
+              "type": "String",
+              "default": "Experimental Features"
+            },
+            "text": {
+              "path": "tags.experimental.text",
+              "desc": "How this tag will display as a label.",
+              "type": "String",
+              "default": "Experimental"
+            },
+            "slug": {
+              "path": "tags.experimental.slug",
+              "desc": "The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.\n\n[NOTE]\nThis technically does not have to be a \"`Slug`\" String, if the system permits spaces.\nIt just needs to exactly match whatever String the remote API returns to represent the label/tag.\n",
+              "type": "String",
+              "default": "experimental"
+            },
+            "icon": {
+              "path": "tags.experimental.icon",
+              "desc": "The icon to use for issues so-tagged.\n",
+              "type": "String",
+              "default": "flask"
+            },
+            "drop": {
+              "path": "tags.experimental.drop",
+              "desc": "Whether to drop this tag when creating a RHYML object from API source.\nBasically decides whether this tag is user-facing.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "groupable": {
+              "path": "tags.experimental.groupable",
+              "desc": "Whether this tag can be used to group issues in the release history.\n",
+              "type": "Boolean",
+              "default": true
+            }
+          }
+        },
+        "internal": {
+          "path": "tags.internal",
+          "desc": "The tag, label, or toggle that indicates an issue documents a feature that is not intended for \"`public`\" use or visibility.",
+          "properties": {
+            "head": {
+              "path": "tags.internal.head",
+              "desc": "How this tag will display as a grouping title.",
+              "type": "String",
+              "default": "Internal Changes"
+            },
+            "text": {
+              "path": "tags.internal.text",
+              "desc": "How this tag will display as a label.",
+              "type": "String",
+              "default": "Internal"
+            },
+            "slug": {
+              "path": "tags.internal.slug",
+              "desc": "The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.\n\n[NOTE]\nThis technically does not have to be a \"`Slug`\" String, if the system permits spaces.\nIt just needs to exactly match whatever String the remote API returns to represent the label/tag.\n",
+              "type": "String",
+              "default": "internal"
+            },
+            "icon": {
+              "path": "tags.internal.icon",
+              "desc": "The icon to use for issues so-tagged.\n",
+              "type": "String",
+              "default": "lock"
+            },
+            "drop": {
+              "path": "tags.internal.drop",
+              "desc": "Whether to drop this tag when creating a RHYML object from API source.\nBasically decides whether this tag is user-facing.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "groupable": {
+              "path": "tags.internal.groupable",
+              "desc": "Whether this tag can be used to group issues in the release history.\n",
+              "type": "Boolean",
+              "default": true
+            }
+          }
+        },
+        "changelog": {
+          "path": "tags.changelog",
+          "desc": "The tag, label, or toggle that indicates an issue should appear in the Changelog even if it does not have a Release Note.\n\nThere is no icon associated with changelog-tagged issues, as it is only declaring that an issue belongs in the Changelog.\n",
+          "properties": {
+            "slug": {
+              "path": "tags.changelog.slug",
+              "desc": "The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.\n\n[NOTE]\nThis technically does not have to be a \"`Slug`\" String, if the system permits spaces.\nIt just needs to exactly match whatever String the remote API returns to represent the label/tag.\n",
+              "type": "String",
+              "default": "changelog"
+            },
+            "drop": {
+              "path": "tags.changelog.drop",
+              "desc": "Whether to drop this tag when creating a RHYML object from API source.\nBasically decides whether this tag is user-facing.\n",
+              "type": "Boolean",
+              "default": true
+            },
+            "groupable": {
+              "path": "tags.changelog.groupable",
+              "desc": "Whether this tag can be used to group issues in the release history.\n",
+              "type": "Boolean",
+              "default": false
+            }
+          }
+        },
+        "release_note_needed": {
+          "path": "tags.release_note_needed",
+          "desc": "The tag, label, or toggle that indicates an issue requires a release note to be written. This is used by the `rhx` CLI to determine which issues are expected to contain release notes when the release-note content is empty.\nThis tag can be automatically removed, and it does not show up in published Changelog or Release Notes (unless you add it).",
+          "properties": {
+            "slug": {
+              "path": "tags.release_note_needed.slug",
+              "desc": "The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.\n\n[NOTE]\nThis technically does not have to be a \"`Slug`\" String, if the system permits spaces.\nIt just needs to exactly match whatever String the remote API returns to represent the label/tag.\n",
+              "type": "String",
+              "default": "release_note_needed"
+            },
+            "drop": {
+              "path": "tags.release_note_needed.drop",
+              "desc": "Whether to drop this tag when creating a RHYML object from API source.\nBasically decides whether this tag is user-facing.\n",
+              "type": "Boolean",
+              "default": true
+            },
+            "groupable": {
+              "path": "tags.release_note_needed.groupable",
+              "desc": "Whether this tag can be used to group issues in the release history.\n",
+              "type": "Boolean",
+              "default": false
+            }
+          }
+        },
+        "<your_tag_name>": {
+          "path": "tags.<your_tag_name>",
+          "desc": "Unlimited custom tags of your choosing, associated with a tag, label, or toggle in the Issues system _or_ manually assignable in RHYML.",
+          "docs": "These property represents any arbitrarily named tags you might wish to add.\nNo `slug` sub-property is available because the name of this property should exactly match your tag/label.\n",
+          "properties": {
+            "head": {
+              "path": "tags.<your_tag_name>.head",
+              "desc": "How this tag will display as a grouping title.",
+              "type": "String"
+            },
+            "text": {
+              "path": "tags.<your_tag_name>.text",
+              "desc": "How this tag will display as a label.",
+              "type": "String"
+            },
+            "icon": {
+              "path": "tags.<your_tag_name>.icon",
+              "desc": "The icon to use for issues so-tagged.\n",
+              "type": "String"
+            },
+            "drop": {
+              "path": "tags.<your_tag_name>.drop",
+              "desc": "Whether to drop this tag when creating a RHYML object from API source.\nBasically decides whether this tag is user-facing.\n",
+              "type": "Boolean"
+            },
+            "groupable": {
+              "path": "tags.<your_tag_name>.groupable",
+              "desc": "Whether this tag can be used to group issues in the release history.\n",
+              "type": "Boolean"
+            }
+          }
+        }
+      }
+    },
+    "links": {
+      "path": "links",
+      "desc": "Path templates and other metadata for building links to online references like issues (web) and commits (git).\n",
+      "properties": {
+        "web": {
+          "path": "links.web",
+          "desc": "Properties to enable linking to issue-management system ticket URLs corresponding to individual changes.",
+          "properties": {
+            "href": {
+              "path": "links.web.href",
+              "desc": "The URL template for the links to the issue-management system ticket URL.\nMay include `{{ tick }}` placeholder or any other from the change object.\n",
+              "docs": "For example:\n\n* `https://jira.example.com/issues/{{ tick }}`\n* `https://github.com/example/project/issues/{{ tick }}`\n\nWeb links must still be enabled in <<conf_ppty_history_items_show_issue_links>>, <<conf_ppty_changelog_items_show_issue_links>>, or <<conf_ppty_notes_items_show_issue_links>> properties.\n",
+              "type": "Liquid"
+            },
+            "icon": {
+              "path": "links.web.icon",
+              "desc": "The icon to use for the issue links.",
+              "type": "String",
+              "default": "ticket"
+            },
+            "text": {
+              "path": "links.web.text",
+              "desc": "The text label to use for the issue links.\nMay include placeholders for any variables in the `change` object.\n",
+              "type": "Liquid",
+              "default": "{{ tick }}"
+            }
+          }
+        },
+        "git": {
+          "path": "links.git",
+          "desc": "Properties to enable linking to the Git commit URL corresponding to individual changes.\n",
+          "properties": {
+            "href": {
+              "path": "links.git.href",
+              "desc": "The URL template for the git links in the release history listings.\nMay include `{{ hash }}` placeholder.\n",
+              "docs": "For example:\n\n* `https://git.example.com/project/commit/{{ hash }}`\n* `https://github.com/example/project/commit/{{ hash }}`\n\nGit links must still be enabled in <<conf_ppty_history_items_show_git_links>>, <<conf_ppty_changelog_items_show_git_links>>, or <<conf_ppty_notes_items_show_git_links>> properties.\n",
+              "type": "Liquid"
+            },
+            "icon": {
+              "path": "links.git.icon",
+              "desc": "The icon to use for the git links.",
+              "type": "String",
+              "default": "code-fork"
+            },
+            "text": {
+              "path": "links.git.text",
+              "desc": "The text label to use for the git links.\nMay include `{{ hash }}` placeholder.\n",
+              "type": "Liquid",
+              "default": "{{ hash | slice: 0, 7 }}"
+            }
+          }
+        },
+        "user": {
+          "path": "links.user",
+          "properties": {
+            "href": {
+              "path": "links.user.href",
+              "desc": "A template for forming links to bio or homepages for the lead contributor of a change.\nMay include `{{ username }}` placeholder.\n",
+              "docs": "For example:\n\n* `https://github.com/{{ username }}`\n",
+              "type": "Template",
+              "templating": {
+                "delay": true,
+                "default": "liquid"
+              }
+            },
+            "icon": {
+              "path": "links.user.icon",
+              "desc": "The icon to use for the user links.",
+              "type": "String",
+              "default": "user"
+            },
+            "text": {
+              "path": "links.user.text",
+              "desc": "The text label to use for the user links.\nMay include `{{ username }}` placeholder.\n",
+              "type": "Liquid",
+              "default": "{{ username }}"
+            }
+          }
+        },
+        "get": {
+          "path": "links.get",
+          "desc": "Properties to enable linking to the download or installation instructions for the release.\n",
+          "properties": {
+            "href": {
+              "path": "links.get.href",
+              "desc": "The URL template for the release download page.\nMay include `{{ code }}` (version ID) as placeholder.\n",
+              "docs": "For example:\n\n* `https://example.com/releases/{{ code }}`\n* `https://example.com/dl/{{ code | replace: '.', '-' }}`\n\nThe existence of this property causes the download link or element to appear in the Release History page.\n",
+              "type": "Liquid"
+            },
+            "icon": {
+              "path": "links.get.icon",
+              "desc": "The icon to use for the download links.",
+              "type": "String",
+              "default": "download"
+            },
+            "text": {
+              "path": "links.get.text",
+              "desc": "The text label to use for the download links.\nMay include `{{ code }}` (version ID) as placeholder.\n",
+              "type": "Liquid",
+              "default": "Download {{ code }}"
+            }
+          }
+        }
+      }
+    },
+    "paths": {
+      "path": "paths",
+      "desc": "The configuration for the paths to include in the release history listings.\n",
+      "properties": {
+        "drafts_dir": {
+          "path": "paths.drafts_dir",
+          "desc": "The path to the output directory for generated drafts (YAML, Markdown, AsciiDoc).\n",
+          "type": "Path",
+          "default": "_drafts"
+        },
+        "enrich_dir": {
+          "path": "paths.enrich_dir",
+          "desc": "The path to the output directory for enriched files (HTML, PDF).\n",
+          "type": "Path",
+          "default": "_publish"
+        },
+        "output_dir": {
+          "path": "paths.output_dir",
+          "desc": "The base directory from which any other output paths are relative.\nThis is the parent directory for <<conf_ppty_paths_drafts_dir>> and <<conf_ppty_paths_enrich_dir>>.\nIt also serves as a base path for any argued files.\n\nExample: If this property is set to `_output`, and <<conf_ppty_paths_drafts_dir>> is `_drafts`, then running `rhx 1.1.0 --md --yaml --asciidoc`  would generate the files at `_releasehx/_drafts/`.\n",
+          "type": "Path",
+          "default": "."
+        },
+        "draft_filename": {
+          "path": "paths.draft_filename",
+          "desc": "The filename template for the draft files.\n",
+          "docs": "May include `{{ version }}` and `{{ format_ext }}` as placeholders, where `format_ext` is determined at file-write time and based on preferences defined in the `config.extensions` block.\n",
+          "type": "FileName",
+          "templating": {
+            "delay": true,
+            "default": "liquid"
+          },
+          "default": "{{ version }}.{{ format_ext }}"
+        },
+        "enrich_filename": {
+          "path": "paths.enrich_filename",
+          "desc": "The filename template for the enriched files.\n",
+          "docs": "May include `{{ version }}` and `{{ format_ext }}` as placeholders, where `format_ext`.\n\nPublished file extensions must be: `.html`, `.pdf`.\nThey can be set with <<conf_ppty_extensions_html>> and <<conf_ppty_extensions_pdf>> properties, respectively.\n",
+          "type": "FileName",
+          "templating": {
+            "delay": true,
+            "default": "liquid"
+          },
+          "default": "release-history-{{ version }}.{{ format_ext }}"
+        },
+        "payloads_dir": {
+          "path": "paths.payloads_dir",
+          "desc": "The path to the directory for storing API payloads.\nThis is used to store the raw API responses for debugging and reference.\n",
+          "type": "Path",
+          "default": "_payloads"
+        },
+        "cache": {
+          "path": "paths.cache",
+          "desc": "Settings for the ReleaseHx application cache.\n",
+          "properties": {
+            "enabled": {
+              "path": "paths.cache.enabled",
+              "desc": "Enable automatic caching of API responses to improve performance and reduce API calls.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "ttl_hours": {
+              "path": "paths.cache.ttl_hours",
+              "desc": "Time-to-live for cached API responses in hours.\nAfter this time, cached responses will be considered stale and fresh data will be fetched from the API.\n",
+              "type": "Integer",
+              "default": 24
+            },
+            "dir": {
+              "path": "paths.cache.dir",
+              "desc": "The directory where cached API responses are stored.\nCache files are organized by API type, project, and version.\n",
+              "type": "Path",
+              "default": ".releasehx/cache"
+            },
+            "prompt_gitignore": {
+              "path": "paths.cache.prompt_gitignore",
+              "desc": "Quietly check the project's git status after writing to cache and, if cache is found untracked, suggest adding this cache path to .gitignore or deleting and disabling caching.\n",
+              "type": "Boolean",
+              "default": true
+            }
+          }
+        },
+        "templates_dir": {
+          "path": "paths.templates_dir",
+          "desc": "The path to the templates directory.\n",
+          "type": "Path",
+          "default": "_templates"
+        },
+        "mappings_dir": {
+          "path": "paths.mappings_dir",
+          "desc": "The path to the directory containing user-defined API mappings.\n\nReleaseHx checks here first for a file named `<origin_source_name>.yaml` or `<origin_source_name>.yml`, where `<origin_source_name>` is set in the `origin.source` property.\nIf no file is found, the mapping is expected to be supplied by the gem (see `<GEM_ROOT>/mappings/`).\n",
+          "type": "String",
+          "default": "_mappings"
+        },
+        "api_clients_dir": {
+          "path": "paths.api_clients_dir",
+          "desc": "The path to the directory containing user-defined API client definitions.\n\nReleaseHx checks here first for a file named `<api_from_name>.yaml`, where `<api_from_name>` is set in the <<conf_ppty_origin_source>>` property.\nIf no file is found, the client class is expected to be supplied by the gem (see `<GEM_ROOT>/lib/releasehx/apis/`).\n",
+          "type": "String",
+          "default": "_apis"
+        }
+      }
+    },
+    "modes": {
+      "path": "modes",
+      "desc": "Default settings for `rhx` command executions.\n",
+      "properties": {
+        "wrapped": {
+          "path": "modes.wrapped",
+          "desc": "Include (or exclude) head, header, and footer elements when enriching to HTML.\n",
+          "type": "Boolean",
+          "default": false
+        },
+        "html_frontmatter": {
+          "path": "modes.html_frontmatter",
+          "desc": "Include frontmatter in the rendered HTML.\n\nSee the `templates.page_frontmatter` property for details.\n",
+          "type": "Boolean",
+          "default": true
+        },
+        "markdown_frontmatter": {
+          "path": "modes.markdown_frontmatter",
+          "desc": "Include frontmatter in Markdown drafts.\n\nUses the `templates.markdown_frontmatter` template.\n",
+          "type": "Boolean",
+          "default": false
+        },
+        "asciidoc_frontmatter": {
+          "path": "modes.asciidoc_frontmatter",
+          "desc": "Include frontmatter in AsciiDoc drafts.\n\nUses the `templates.asciidoc_frontmatter` template.\n",
+          "type": "Boolean"
+        },
+        "fetch": {
+          "path": "modes.fetch",
+          "desc": "What to fetch when gathering issues from API.\n\nValid entries:\n\n* `all-tagged` -- fetches issues with `release_note_needed` tag.\n",
+          "type": "String",
+          "default": "notes-only"
+        },
+        "remove_excess_lines": {
+          "path": "modes.remove_excess_lines",
+          "desc": "Reduces _N_+ consecutive blank lines to _N_ lines.\n",
+          "type": "Integer",
+          "default": 1
+        }
+      }
+    },
+    "rhyml": {
+      "path": "rhyml",
+      "desc": "Settings related to RHYML data objects and documents.\n",
+      "properties": {
+        "markup": {
+          "path": "rhyml.markup",
+          "desc": "The markup format for the `note` or `memo` properties of RHYML objects.\n\nChange to `asciidoc` to convert upstream Markdown to AsciiDoc.\n\nThis setting can be set (and overridden) with the `$config.markup` property in any given RHYML document.\n",
+          "type": "String",
+          "default": "markdown"
+        },
+        "chid": {
+          "path": "rhyml.chid",
+          "desc": "The template for automatic change ID/slug construction, if available at draft-time.\n",
+          "docs": "A liquid template with access to local variables including:\n\nRelease variables::\n\n* `release.code`\n* `release.date`\n* `release.hash`\n\nWork/change item variables::\n\n* `change.tick`\n* `change.hash`\n* `change.type`\n* `change.part`\n* `change.summ`\n\nThe template established here is only for drafting `chid` slugs.\nIt is not used down the line to validate `chid` entries, which will be valid as long as they are Slug-formatted strings.\n",
+          "type": "Slug",
+          "templating": {
+            "delay": true,
+            "default": "liquid"
+          },
+          "default": "{{- change.tick }}-{{ change.summ | truncate: 20 | slugify }}\n"
+        },
+        "empty_notes": {
+          "path": "rhyml.empty_notes",
+          "desc": "What to do for issues that lack a release note but have the `release_note_needed` tag (or a label otherwise declared in <<conf_ppty_tags_release_note_needed_slug>>).\n\n* `skip` the issue when drafting notes (can update with `--amend`)\n* `empty` include the issue with an empty note\n* `dump` the complete issue body/description and commit message as the `note` property\n// * `ai` generate a note using generative AI\n",
+          "type": "String",
+          "default": "skip"
+        },
+        "empty_notes_content": {
+          "path": "rhyml.empty_notes_content",
+          "desc": "The content to use for empty notes when <<conf_ppty_rhyml_empty_notes>> is set to 'empty'\n",
+          "type": "String",
+          "default": "RELEASE NOTE NEEDED"
+        },
+        "max_parts": {
+          "path": "rhyml.max_parts",
+          "desc": "The maximum number of affected _part_ categories that can be recorded for a single change.\n\nWhen `0`, _part_ records are disabled for all changes.\nWhen `1`, only one _part_ is allowed per change (String).\nWhen `2` or more, a single affiliated _part_ category may be recorded using the `part` property, but more than one must be recorded using the `parts` property (Array).\n",
+          "type": "Integer",
+          "default": 1
+        },
+        "pasterize_summ": {
+          "path": "rhyml.pasterize_summ",
+          "desc": "Whether to convert verbs in the `summ` property to past tense when drafting.\nReplaces common words like `adds` with `added`, `fix` with `fixed`, etc.\n",
+          "type": "Boolean",
+          "default": false
+        },
+        "pasterize_head": {
+          "path": "rhyml.pasterize_head",
+          "desc": "Whether to convert verbs in the `head` property to past tense when drafting.\nReplaces common words like `adds` with `added`, `fix` with `fixed`, etc.\n",
+          "type": "Boolean",
+          "default": false
+        }
+      }
+    },
+    "history": {
+      "path": "history",
+      "desc": "Configurations for the overall document, when applicable.\n",
+      "properties": {
+        "head": {
+          "path": "history.head",
+          "desc": "The header for the release history output.\n",
+          "type": "String",
+          "templating": {
+            "delay": true,
+            "default": "liquid"
+          },
+          "default": "Release History -- {{ release.code }} - {{ release.date }}"
+        },
+        "htag": {
+          "path": "history.htag",
+          "desc": "The heading level (H1, H2, etc) for the release history header.\n",
+          "type": "String",
+          "default": "h1"
+        },
+        "markdown_frontmatter": {
+          "path": "history.markdown_frontmatter",
+          "desc": "Designates the content inserted at the top of Markdown files as document-level metadata.\n",
+          "docs": "A Liquid template to be prepended at the top of Markdown draft files.\n\nTemplates may contain the following variables, automatically generated, as applicable:\n\n* `date` (DateTime)\n* `version` (String)\n* `title` (String)          \n",
+          "type": "Liquid",
+          "default": "---\ntitle: Release History for {{ release.code }}\nversion: {{ release.code }}\ndate: {{ release.date }}\n---\n"
+        },
+        "asciidoc_frontmatter": {
+          "path": "history.asciidoc_frontmatter",
+          "desc": "Designates the way front-matter is inserted at the top of AsciiDoc files.\nSeveral variables are available to templates.\n\nAsciiDoc frontmatter templates may also contain AsciiDoc attribute placeholders.\n",
+          "type": "Liquid",
+          "default": ":page-title: Release History for {{ release.code }}\n:page-version: {{ release.code }}\n:page-date: {{ release.date }}\n"
+        },
+        "html_frontmatter": {
+          "path": "history.html_frontmatter",
+          "desc": "Designates the way front-matter is inserted at the top of _unwrapped_ rendered HTML.\n",
+          "docs": "The `frontmatter` property is a Liquid template that is inserted at the top of the rendered HTML file.\n\nIt may include `{{ title }}`, `{{ version }}`, `{{ date }}`, as well as any `vars`-scoped variables as you pass in.\n",
+          "type": "Liquid",
+          "default": "---\ntitle: Release History for {{ release.code }}\nversion: {{ release.code }}\ndate: {{ release.date }}\n---\n"
+        },
+        "items": {
+          "path": "history.items",
+          "desc": "Settings pertaining to displayed items across Changelog and Release Notes sections.\n\nMost of these settings can be defined separately for each section under <<conf_ppty_changelog_items>> and <<conf_ppty_notes_items>>.\nIf an identically named setting exists, it will override the primary designator defined in this `config.history.items` block.\n",
+          "properties": {
+            "allow_redundant": {
+              "path": "history.items.allow_redundant",
+              "desc": "Whether to allow duplicate entries in a given section, for instance across groups for `part:group` sorts where a change affects multiple parts.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_issue_links": {
+              "path": "history.items.show_issue_links",
+              "desc": "Whether to include web links in item metadata.\n\nRequires `links.web` to be defined.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_git_links": {
+              "path": "history.items.show_git_links",
+              "desc": "Whether to include git links in item metadata.\n\nRequires `links.git` to be defined.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "metadata_labels": {
+              "path": "history.items.metadata_labels",
+              "desc": "If and where to display icons in relation to labels in item metadata.\n\nUse `before` or `after` to choose a spot, `none` or `'$nil'` to disable.\n",
+              "type": "String",
+              "default": "before"
+            },
+            "metadata_icons": {
+              "path": "history.items.metadata_icons",
+              "desc": "Whether to include icons for metadata in item metadata.\n",
+              "type": "Boolean",
+              "default": "before"
+            },
+            "show_lead": {
+              "path": "history.items.show_lead",
+              "desc": "Whether to include the lead-in text for the section in the item metadata.\nThis is useful for displaying the section header in the item metadata.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_type_label": {
+              "path": "history.items.show_type_label",
+              "desc": "Whether to show the type label in the item metadata output.\nIf `false`, the type will be listed unlabeled in the output, for templates that support this option.\n\nCorresponds to the <<conf_ppty_history_labeling_type_label>> property, which defines the content displayed when this property is `true` for a given section of the history output.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_parts_label": {
+              "path": "history.items.show_parts_label",
+              "desc": "Whether to show the parts label in the item metadata output.\nIf `false`, parts will be listed unlabeled in the output, for templates that support this option.\n\nCorresponds to the <<conf_ppty_history_labeling_parts_label>> property (and optionally the <<conf_ppty_history_labeling_part_label>>), which defines the content displayed when this property is `true` for a given section of the history output.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_tags_label": {
+              "path": "history.items.show_tags_label",
+              "desc": "Whether to show the tags label in the item metadata output.\nIf `false`, tags will be listed unlabeled in the output, for templates that support this option.\n\nCorresponds to the <<conf_ppty_history_labeling_tags_label>> property (and optionally the <<conf_ppty_history_labeling_tag_label>>), which defines the content displayed when this property is `true` for a given section of the history output.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_lead_label": {
+              "path": "history.items.show_lead_label",
+              "desc": "Whether to show the lead label in the item metadata output.\nIf `false`, the lead will be listed unlabeled in the output, for templates that support this option.\n\nCorresponds to the <<conf_ppty_history_labeling_lead_label>> property, which defines the content displayed when this property is `true` for a given section of the history output.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_auths_label": {
+              "path": "history.items.show_auths_label",
+              "desc": "Whether to show the authors label in the item metadata output.\nIf `false`, authors will be listed unlabeled in the output, for templates that support this option.\n\nCorresponds to the <<conf_ppty_history_labeling_auth_label>> property, which defines the content displayed when this property is `true` for a given section of the history output.\n",
+              "type": "Boolean",
+              "default": false
+            }
+          }
+        },
+        "labeling": {
+          "path": "history.labeling",
+          "desc": "Settings for labeling items in the release history output.\nThese properties establish how metadata and other elements apply to a given subject's nomenclature.\nIf you want to refer to \"`tags`\" as \"`labels`\" or \"`parts`\" as \"`components`\", map those namespaces here.\n",
+          "properties": {
+            "singularize_labels": {
+              "path": "history.labeling.singularize_labels",
+              "desc": "Whether to singularize labels in the output _when only one instance_ of the category is present.\nFor instance, if a change has only one part and the `conf_ppty_history_labeling_part_label` is set to `Part`, the output will use labeling like *Part:* instead of *Parts:*.\n\nThis also applies to `tag_label` and `auth_label` as well as the `part_label`.\nThe `type` and `lead` labels are not affected by this setting.\n",
+              "type": "Boolean",
+              "default": true
+            },
+            "type_label": {
+              "path": "history.labeling.type_label",
+              "desc": "The label to use for the type of change.\nDefaults to the `type.text` property of the change.\n",
+              "type": "String",
+              "default": "type"
+            },
+            "type_icon": {
+              "path": "history.labeling.type_icon",
+              "desc": "The icon to use for the type of change.\nDefaults to the `type.icon` property of the change.\n",
+              "type": "String"
+            },
+            "parts_label": {
+              "path": "history.labeling.parts_label",
+              "desc": "The label to use for the part/component affected by the change.\n",
+              "type": "String",
+              "default": "Components"
+            },
+            "part_label": {
+              "path": "history.labeling.part_label",
+              "desc": "The label to use for the _singular_ part/component affected by the change, when only one part is permitted.\n\nThis value will apply either when <<conf_ppty_rhyml_max_parts>> is set to `1` or when the change has only one part _and_ <<conf_ppty_history_labeling_singularize_labels>> is `true`.\n",
+              "type": "String",
+              "default": "Part"
+            },
+            "parts_icon": {
+              "path": "history.labeling.parts_icon",
+              "desc": "The icon to use for the part/component affected by the change.\n",
+              "type": "String",
+              "default": "puzzle-piece"
+            },
+            "tags_label": {
+              "path": "history.labeling.tags_label",
+              "desc": "The tags associated with the change, if any.\nDefaults to an empty array.\n",
+              "type": "Array",
+              "default": "Tags"
+            },
+            "tag_label": {
+              "path": "history.labeling.tag_label",
+              "desc": "The label to use for the _singular_ tag associated with the change, when only one tag is permitted.\n\nThis value will apply either when <<conf_ppty_rhyml_max_parts>> is set to `1` or when the change has only one tag _and_ <<conf_ppty_history_labeling_singularize_labels>> is `true`.\n\nIn supporting templates, this label will only be displayed if the show_tags_label` setting is `true` for the relevant section.\n",
+              "type": "String",
+              "default": "Tag"
+            },
+            "tags_icon": {
+              "path": "history.labeling.tags_icon",
+              "desc": "The icon to use for the tags associated with the change.\n",
+              "type": "String",
+              "default": "tags"
+            },
+            "lead_label": {
+              "path": "history.labeling.lead_label",
+              "desc": "The label to use for the lead contributor of the change.\n",
+              "type": "String",
+              "default": "Contributed by"
+            },
+            "lead_icon": {
+              "path": "history.labeling.lead_icon",
+              "desc": "The icon to use for the lead contributor of the change.\n",
+              "type": "String",
+              "default": "user"
+            },
+            "auths_label": {
+              "path": "history.labeling.auths_label",
+              "desc": "The label to use for the authors of the change.\nThis is used when multiple authors are present.\n",
+              "type": "String",
+              "default": "Contributors"
+            },
+            "auth_label": {
+              "path": "history.labeling.auth_label",
+              "desc": "The label to use for the _singular_ author of the change, when only one author is listed and <<conf_ppty_history_labeling_singularize_labels>> is `true`.\n",
+              "type": "String"
+            },
+            "join_string": {
+              "path": "history.labeling.join_string",
+              "desc": "The string to use to join multiple tags, parts, or authors in the output.\nDefaults to a comma and space (`, `).\n",
+              "type": "String",
+              "default": ", "
+            }
+          }
+        }
+      }
+    },
+    "changelog": {
+      "path": "changelog",
+      "desc": "The configuration for the changelog output.\n",
+      "properties": {
+        "head": {
+          "path": "changelog.head",
+          "desc": "The header for the changelog output.\n",
+          "type": "String",
+          "templating": {
+            "delay": true,
+            "default": "liquid"
+          },
+          "default": "Changelog"
+        },
+        "text": {
+          "path": "changelog.text",
+          "desc": "The text for the changelog output.\nChange to `null` to hide.\n",
+          "type": "String",
+          "templating": {
+            "delay": true,
+            "default": "liquid"
+          },
+          "default": "Summaries of all user-facing changes made since the previous release.\n"
+        },
+        "htag": {
+          "path": "changelog.htag",
+          "desc": "The heading level (H1, H2, etc) for the changelog section header.\n",
+          "type": "String",
+          "default": "h2"
+        },
+        "spot": {
+          "path": "changelog.spot",
+          "desc": "Where in the document to place the changelog (`1` = top, `2` = bottom).\n",
+          "type": "Integer",
+          "default": 2
+        },
+        "sort": {
+          "path": "changelog.sort",
+          "desc": "The sort order for the changelog output.\n",
+          "docs": "Indicate whether you wish to _group_ output by this sort criterion, or else just order by that criteria, with or without a label denoting the criterion.\n\nIf `<criterion>:group` (default), the output will be grouped into sections with the group instance \nIf `<criterion>:grouping1`, the criterion will be added to the first of 2 grouping tiers into which the output will be divided.\nIf `<criterion>:grouping2`, the criterion will be added to the second of 2 grouping tiers into which the output will be divided.\nIf `<criterion>:label`, the output will be order by the criterion, with a label indicating the criterion.\nIf `<criterion>:none`, the output will be ordered by the criterion, with no label.\n\nFor example:\n\n[source,yaml]\n----\nsort:\n  - 'part:group'\n  - 'type:label'\n----\n\nWould produce something like:\n\n[source,markdown]\n----\n## Web UI\n\n- Feature description or summary [New feature]\n\n- Another feature description or summary [New feature]\n\n- Improvement description or summary [Improvement]\n\n## Backend\n\n- Feature description or summary [New feature]\n\n- Bug fix description or summary [Bug Fixes]\n----\n\nFor 2-tiered grouping arrangements, use something like:\n\n[source,yaml]\n----\nsort:\n  - 'part:grouping1'\n  - 'type:grouping2'\n----\n\nThis would output for instance:\n\n[source,markdown]\n----\n## Web UI\n\n### New features\n- Feature description or summary\n- Another feature description or summary\n\n### Improvements\n- Improvement description or summary\n----\n\nYou may also use tag-based groupings, but the tags must be listed explicitly.\n\n[source,yaml]\n----\nsort:\n  - 'breaking:group'\n  - 'deprecation:group'\n  - 'type:group'\n  - 'part:label'\n----\n\nThis would output something akin to:\n\n[source,markdown]\n----\n## Breaking Changes\n- We are breaking this thing! [Web UI]\n\n## Deprecations\n- We are deprecating this thing! [Backend]\n\n## New features\n- Feature description or summary [Web UI]\n- Another feature description or summary [Web UI]\n\n## Improvements\n- Improvement description or summary [Backend]\n----\n",
+          "type": "Array",
+          "default": [
+            "part:grouping1"
+          ]
+        },
+        "items": {
+          "path": "changelog.items",
+          "desc": "Settings that affect the frame/shape and arrangement of individual changelog entries.\n",
+          "properties": {
+            "frame": {
+              "path": "changelog.items.frame",
+              "desc": "The layout for the changelog entry display.\n\nCan be `ordered`, `unordered`, `paragraph`, or `basic`.\n",
+              "type": "String",
+              "default": "unordered"
+            },
+            "allow_redundant": {
+              "path": "changelog.items.allow_redundant",
+              "desc": "Whether to allow duplicate entries in a given section, for instance across groups for `part:group` sorts where a change affects multiple parts.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_git_links": {
+              "path": "changelog.items.show_git_links",
+              "desc": "Whether to include git links in item metadata.\n\nRequires `links.git` to be defined.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_issue_links": {
+              "path": "changelog.items.show_issue_links",
+              "desc": "Whether to include web links in item metadata.\n\nRequires `links.web` to be defined.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "metadata_labels": {
+              "path": "changelog.items.metadata_labels",
+              "desc": "If and where to display icons in relation to labels in item metadata.\n\nUse `before` or `after` to choose a spot, `none` or `'$nil'` to disable.\n",
+              "type": "String",
+              "default": "before"
+            },
+            "metadata_icons": {
+              "path": "changelog.items.metadata_icons",
+              "desc": "Whether to include icons for metadata in item metadata.\n",
+              "type": "Boolean",
+              "default": "before"
+            },
+            "show_lead": {
+              "path": "changelog.items.show_lead",
+              "desc": "Whether to include the lead-in text for the section in the item metadata.\nThis is useful for displaying the section header in the item metadata.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_type_label": {
+              "path": "changelog.items.show_type_label",
+              "desc": "Whether to show the type label in the item metadata output.\nIf `false`, the type will be listed unlabeled in the output, for templates that support this option.\n\nCorresponds to the <<conf_ppty_history_labeling_type_label>> property, which defines the content displayed when this property is `true` for a given section of the history output.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_parts_label": {
+              "path": "changelog.items.show_parts_label",
+              "desc": "Whether to show the parts label in the item metadata output.\nIf `false`, parts will be listed unlabeled in the output, for templates that support this option.\n\nCorresponds to the <<conf_ppty_history_labeling_parts_label>> property (and optionally the <<conf_ppty_history_labeling_part_label>>), which defines the content displayed when this property is `true` for a given section of the history output.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_tags_label": {
+              "path": "changelog.items.show_tags_label",
+              "desc": "Whether to show the tags label in the item metadata output.\nIf `false`, tags will be listed unlabeled in the output, for templates that support this option.\n\nCorresponds to the <<conf_ppty_history_labeling_tags_label>> property (and optionally the <<conf_ppty_history_labeling_tag_label>>), which defines the content displayed when this property is `true` for a given section of the history output.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_lead_label": {
+              "path": "changelog.items.show_lead_label",
+              "desc": "Whether to show the lead label in the item metadata output.\nIf `false`, the lead will be listed unlabeled in the output, for templates that support this option.\n\nCorresponds to the <<conf_ppty_history_labeling_lead_label>> property, which defines the content displayed when this property is `true` for a given section of the history output.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_auths_label": {
+              "path": "changelog.items.show_auths_label",
+              "desc": "Whether to show the authors label in the item metadata output.\nIf `false`, authors will be listed unlabeled in the output, for templates that support this option.\n\nCorresponds to the <<conf_ppty_history_labeling_auth_label>> property, which defines the content displayed when this property is `true` for a given section of the history output.\n",
+              "type": "Boolean",
+              "default": false
+            }
+          }
+        }
+      }
+    },
+    "notes": {
+      "path": "notes",
+      "desc": "The configuration for the Release Notes listing section.\n",
+      "properties": {
+        "head": {
+          "path": "notes.head",
+          "desc": "The header for the notes output.\n",
+          "type": "String",
+          "templating": {
+            "delay": true,
+            "default": "liquid"
+          },
+          "default": "Release Notes"
+        },
+        "text": {
+          "path": "notes.text",
+          "desc": "The text for the release notes output.\nChange to `null` to hide.\n",
+          "type": "String",
+          "templating": {
+            "delay": true,
+            "default": "liquid"
+          },
+          "default": "Descriptions of any specially notable changes or additions since the previous release.\n"
+        },
+        "htag": {
+          "path": "notes.htag",
+          "desc": "The heading level (H1, H2, etc) for the release notes section header.\n",
+          "type": "String",
+          "default": "h2"
+        },
+        "spot": {
+          "path": "notes.spot",
+          "desc": "Where in the document to place the Release Notes relative to the Changelog.\n",
+          "type": "Integer",
+          "default": 1
+        },
+        "sort": {
+          "path": "notes.sort",
+          "desc": "The sort *order* for the release notes output.\n",
+          "docs": "Indicate whether you wish to _group_ output by this sort criterion, or else just order by that criteria, with or without a label denoting the criterion.\n\nIf `<criterion>:group` (default), the output will be grouped into sections with the group instance \nIf `<criterion>:grouping1`, the criterion will be added to the first of 2 grouping tiers into which the output will be divided.\nIf `<criterion>:grouping2`, the criterion will be added to the second of 2 grouping tiers into which the output will be divided.\nIf `<criterion>:label`, the output will be order by the criterion, with a label indicating the criterion.\nIf `<criterion>:none`, the output will be ordered by the criterion, with no label.\n\nFor example:\n\n[source,yaml]\n----\nsort:\n  - 'part:group'\n  - 'type:label'\n----\n\nWould produce something like:\n\n[source,markdown]\n----\n## Web UI\n\n- Feature description or summary [New feature]\n\n- Another feature description or summary [New feature]\n\n- Improvement description or summary [Improvement]\n\n## Backend\n\n- Feature description or summary [New feature]\n\n- Bug fix description or summary [Bug Fixes]\n----\n\nFor 2-tiered grouping arrangements, use something like:\n\n[source,yaml]\n----\nsort:\n  - 'part:grouping1'\n  - 'type:grouping2'\n----\n\nThis would output for instance:\n\n[source,markdown]\n----\n## Web UI\n\n### New features\n- Feature description or summary\n- Another feature description or summary\n\n### Improvements\n- Improvement description or summary\n----\n\nYou may also use tag-based groupings, but the tags must be listed explicitly.\n\n[source,yaml]\n----\nsort:\n  - 'breaking:group'\n  - 'deprecation:group'\n  - 'type:group'\n  - 'part:label'\n----\n\nThis would output something akin to:\n\n[source,markdown]\n----\n## Breaking Changes\n- We are breaking this thing! [Web UI]\n\n## Deprecations\n- We are deprecating this thing! [Backend]\n\n## New features\n- Feature description or summary [Web UI]\n- Another feature description or summary [Web UI]\n\n## Improvements\n- Improvement description or summary [Backend]\n----\n",
+          "type": "Array",
+          "default": [
+            "highlight:grouping1",
+            "deprecation:grouping1",
+            "removal:grouping1",
+            "breaking:grouping1",
+            "type:grouping1",
+            "part:grouping2"
+          ]
+        },
+        "items": {
+          "path": "notes.items",
+          "desc": "Settings that affect the frame/shape and arrangement of individual release-note item displays.\n",
+          "properties": {
+            "frame": {
+              "path": "notes.items.frame",
+              "desc": "The layout for the release-note item display.\n\nCan be `table-cols-1`, `table-cols-2`, `desc-list`, or `admonition`.\n",
+              "type": "String",
+              "default": "table-cols-1"
+            },
+            "allow_redundant": {
+              "path": "notes.items.allow_redundant",
+              "desc": "Whether to allow duplicate entries in a given section, for instance across groups for `part:group` sorts where a change affects multiple parts.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_git_links": {
+              "path": "notes.items.show_git_links",
+              "desc": "Whether to include git links in item metadata.\n\nRequires `links.git` to be defined.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_issue_links": {
+              "path": "notes.items.show_issue_links",
+              "desc": "Whether to include web links in item metadata.\n\nRequires `links.web` to be defined.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "metadata_labels": {
+              "path": "notes.items.metadata_labels",
+              "desc": "If and where to display icons in relation to labels in item metadata.\n\nUse `before` or `after` to choose a spot, `none` or `'$nil'` to disable.\n",
+              "type": "String",
+              "default": "before"
+            },
+            "metadata_icons": {
+              "path": "notes.items.metadata_icons",
+              "desc": "Whether to include icons for metadata in item metadata.\n",
+              "type": "Boolean",
+              "default": "before"
+            },
+            "show_lead": {
+              "path": "notes.items.show_lead",
+              "desc": "Whether to include the lead-in text for the section in the item metadata.\nThis is useful for displaying the section header in the item metadata.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_type_label": {
+              "path": "notes.items.show_type_label",
+              "desc": "Whether to show the type label in the item metadata output.\nIf `false`, the type will be listed unlabeled in the output, for templates that support this option.\n\nCorresponds to the <<conf_ppty_history_labeling_type_label>> property, which defines the content displayed when this property is `true` for a given section of the history output.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_parts_label": {
+              "path": "notes.items.show_parts_label",
+              "desc": "Whether to show the parts label in the item metadata output.\nIf `false`, parts will be listed unlabeled in the output, for templates that support this option.\n\nCorresponds to the <<conf_ppty_history_labeling_parts_label>> property (and optionally the <<conf_ppty_history_labeling_part_label>>), which defines the content displayed when this property is `true` for a given section of the history output.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_tags_label": {
+              "path": "notes.items.show_tags_label",
+              "desc": "Whether to show the tags label in the item metadata output.\nIf `false`, tags will be listed unlabeled in the output, for templates that support this option.\n\nCorresponds to the <<conf_ppty_history_labeling_tags_label>> property (and optionally the <<conf_ppty_history_labeling_tag_label>>), which defines the content displayed when this property is `true` for a given section of the history output.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_lead_label": {
+              "path": "notes.items.show_lead_label",
+              "desc": "Whether to show the lead label in the item metadata output.\nIf `false`, the lead will be listed unlabeled in the output, for templates that support this option.\n\nCorresponds to the <<conf_ppty_history_labeling_lead_label>> property, which defines the content displayed when this property is `true` for a given section of the history output.\n",
+              "type": "Boolean",
+              "default": false
+            },
+            "show_auths_label": {
+              "path": "notes.items.show_auths_label",
+              "desc": "Whether to show the authors label in the item metadata output.\nIf `false`, authors will be listed unlabeled in the output, for templates that support this option.\n\nCorresponds to the <<conf_ppty_history_labeling_auth_label>> property, which defines the content displayed when this property is `true` for a given section of the history output.\n",
+              "type": "Boolean",
+              "default": false
+            }
+          }
+        }
+      }
+    }
+  }
+}