This is a “kitchen sink” example of the ReleaseHx configuration settings.
# Sample configuration file generated from the configuration definition.
# All values are upstream (gem) defaults.
# Properties without defaults are commented out.
$meta: # The metadata settings for the configuration file.
markup: markdown # The markup format used in strings in this configuration file.
slug_type: kebab # The format of slugs used in your application, for use with sluggerize Liquid filter.
tplt_lang: liquid # The default format used in fields of Template type.
origin: # The API or file source for the issues.
source: rhyml # Issue source API type (jira, github, gitlab, rhyml)
# project: # The string used to identify the project in the remote API.
# href: | # The local or remote URI for the API or JSON file.
auth: # Properties related to API authentication.
# mode: # The type of authentication to use.
# header: # The header to use for authentication.
cred_uri: RELEASEHX_API_CRED # The location of the API credentials file for declaring API authentication arguments without environment variables.
cred_key_line: 1 # Number of the line of the credentials file (at <<confpptyoriginauthcreduri>>) on which the key or token string appears.
cred_user_line: 2 # Number of the line of the credentials file (at <<confpptyoriginauthcreduri>>) on which the user string appears.
cred_org_line: 3 # Number of the line of the credentials file (at <<confpptyoriginauthcreduri>>) on which the org string appears.
key_env: RELEASEHX_API_KEY # Name of the environment variable containing the API key or token.
user_env: RELEASEHX_API_USER # Name of the environment variable containing the API username.
org_env: RELEASEHX_API_ORG # Name of the environment variable containing the organization credential.
conversions: # Details about content origination, as well as markup sources and conversion.
summ: issue # The source of the summary (Changelog) content.
# head: # The source of release-note headlines, when it is not the same as the summary.
# note: # The source of the release notes content.
# note_custom_field: # The name of the custom field to use for the release notes content.Liquid error: wrong number of arguments (given 3, expected 1..2)Liquid error: wrong number of arguments (given 3, expected 1..2)
markup: markdown # The origin markup format for notes.
# engine: # The markup converter to use for the issues.
extensions: # Default file extensions.
markdown: md # File extension for Markdown drafts.
asciidoc: adoc # File extension for AsciiDoc drafts.
yaml: yml # File extension for YAML drafts.
types: # Issue types to include in the release history, in the order of display.
label_prefix: # The prefix used in issue labels to identify type labels.
feature: # A new capability, functionality, or interface element.
slug: feature # The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than...
text: New feature # The display label for the type in the release history output.
head: New features # The header for the type in the release history output.
icon: plus-square-o # The icon to use for issues of this type.
bug: # A fix for a previously reported issue.
slug: bug # The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than...
text: Bug fix # The display label for the type in the release history output.
head: Bug fixes # The header for the type in the release history output.
icon: bug # The icon to use for issues of this type.
improvement: # An enhancement to an existing capability, functionality, or interface element.
slug: improvement # The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than...
text: Improvement # The display label for the type in the release history output.
head: Improvements # The header for the type in the release history output.
icon: wrench # The icon to use for issues of this type.
documentation: # An update to the documentation.
slug: documentation # The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than...
text: Documentation # The display label for the type in the release history output.
head: Docs Changes # The header for the type in the release history output.
icon: book # The icon to use for issues of this type.
# <type_name>: # The corresponding issue type.
# slug: # The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than...
# text: # The display label for the type in the release history output.
# head: # The header for the type in the release history output.
# icon: # The icon to use for issues of this type.
parts: # The map of product components to include in the release history, in the order of display.
label_prefix: "part:" # The prefix used in issue labels to identify component/part labels.
# <part_name>: # The corresponding product component.
# slug: # The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than...
# text: # The display text for the component in the release history output.
# head: # The header for the component in the release history output.
# icon: # The icon to use for issues that affect this component.
tags: # Handling for tags, labels, or toggles associated with source Issues.
_include: # The tags, labels, or toggles that trigger inclusion in the release history.
- highlight
- deprecation
- removal
- breaking
- experimental
- changelog
_exclude: # The list of tags that cause a change/issue to be excluded from the release history.
highlight: # The tag, label, or toggle that indicates an issue is to be highlighted or prioritized in sorts.
head: Highlights # How this tag will display as a grouping title.
text: highlight # How this tag will display as a label.
slug: highlighted # The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than...
icon: star # The icon to use for issues so-tagged.
drop: false # Whether to drop this tag when creating a RHYML object from API source.
groupable: true # Whether this tag can be used to group issues in the release history.
breaking: # The tag, label, or toggle that indicates a potentially disruptive change.
head: Breaking Changes # How this tag will display as a grouping title.
text: Breaking # How this tag will display as a label.
slug: breaking # The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than...
icon: exclamation-triangle # The icon to use for issues so-tagged.
drop: false # Whether to drop this tag when creating a RHYML object from API source.
groupable: true # Whether this tag can be used to group issues in the release history.
removal: # The tag, label, or toggle that indicates a change includes a feature removal.
head: Feature Removals # How this tag will display as a grouping title.
text: Removed # How this tag will display as a label.
slug: removal # The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than...
icon: sign-out # The icon to use for issues so-tagged.
drop: false # Whether to drop this tag when creating a RHYML object from API source.
groupable: true # Whether this tag can be used to group issues in the release history.
deprecation: # The tag, label, or toggle that indicates an issue includes a feature discontinuation announcement.
head: Deprecations # How this tag will display as a grouping title.
text: Deprecated # How this tag will display as a label.
slug: deprecation # The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than...
icon: exclamation-triangle # The icon to use for issues so-tagged.
drop: false # Whether to drop this tag when creating a RHYML object from API source.
groupable: true # Whether this tag can be used to group issues in the release history.
security: # The tag, label, or toggle that indicates a change includes a security-related alteration.
head: Security Fixes # How this tag will display as a grouping title.
text: Security # How this tag will display as a label.
slug: security # The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than...
icon: shield # The icon to use for issues so-tagged.
drop: false # Whether to drop this tag when creating a RHYML object from API source.
groupable: true # Whether this tag can be used to group issues in the release history.
experimental: # The tag, label, or toggle that indicates a feature that is not yet stable or may not be permanent.
head: Experimental Features # How this tag will display as a grouping title.
text: Experimental # How this tag will display as a label.
slug: experimental # The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than...
icon: flask # The icon to use for issues so-tagged.
drop: false # Whether to drop this tag when creating a RHYML object from API source.
groupable: true # Whether this tag can be used to group issues in the release history.
internal: # The tag, label, or toggle that indicates an issue documents a feature that is not intended for "public" use or...
head: Internal Changes # How this tag will display as a grouping title.
text: Internal # How this tag will display as a label.
slug: internal # The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than...
icon: lock # The icon to use for issues so-tagged.
drop: false # Whether to drop this tag when creating a RHYML object from API source.
groupable: true # Whether this tag can be used to group issues in the release history.
changelog: # The tag, label, or toggle that indicates an issue should appear in the Changelog even if it does not have...
slug: changelog # The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than...
drop: true # Whether to drop this tag when creating a RHYML object from API source.
groupable: false # Whether this tag can be used to group issues in the release history.
release_note_needed: # The tag, label, or toggle that indicates an issue requires a release note to be written. This is used by...
slug: release_note_needed # The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than...
drop: true # Whether to drop this tag when creating a RHYML object from API source.
groupable: false # Whether this tag can be used to group issues in the release history.
# <your_tag_name>: # Unlimited custom tags of your choosing, associated with a tag, label, or toggle in the Issues system or manually assignable...
# head: # How this tag will display as a grouping title.
# text: # How this tag will display as a label.
# icon: # The icon to use for issues so-tagged.
# drop: # Whether to drop this tag when creating a RHYML object from API source.
# groupable: # Whether this tag can be used to group issues in the release history.
links: # Path templates and other metadata for building links to online references like issues (web) and commits (git).
web: # Properties to enable linking to issue-management system ticket URLs corresponding to individual changes.
# href: | # The URL template for the links to the issue-management system ticket URL.
icon: ticket # The icon to use for the issue links.Liquid error: wrong number of arguments (given 3, expected 1..2)
git: # Properties to enable linking to the Git commit URL corresponding to individual changes.
# href: | # The URL template for the git links in the release history listings.
icon: code-fork # The icon to use for the git links.Liquid error: wrong number of arguments (given 3, expected 1..2)
user:
# href: | # A template for forming links to bio or homepages for the lead contributor of a change.
icon: user # The icon to use for the user links.Liquid error: wrong number of arguments (given 3, expected 1..2)
get: # Properties to enable linking to the download or installation instructions for the release.
# href: | # The URL template for the release download page.
icon: download # The icon to use for the download links.Liquid error: wrong number of arguments (given 3, expected 1..2)
paths: # The configuration for the paths to include in the release history listings.
drafts_dir: _drafts # The path to the output directory for generated drafts (YAML, Markdown, AsciiDoc).
enrich_dir: _publish # The path to the output directory for enriched files (HTML, PDF).
output_dir: . # The base directory from which any other output paths are relative.Liquid error: wrong number of arguments (given 3, expected 1..2)Liquid error: wrong number of arguments (given 3, expected 1..2)
payloads_dir: _payloads # The path to the directory for storing API payloads.
cache: # Settings for the ReleaseHx application cache.
enabled: false # Enable automatic caching of API responses to improve performance and reduce API calls.
ttl_hours: 24 # Time-to-live for cached API responses in hours.
dir: .releasehx/cache # The directory where cached API responses are stored.
prompt_gitignore: true # Quietly check the project's git status after writing to cache and, if cache is found untracked, suggest adding this cache...
templates_dir: _templates # The path to the templates directory.
mappings_dir: _mappings # The path to the directory containing user-defined API mappings.
api_clients_dir: _apis # The path to the directory containing user-defined API client definitions.
modes: # Default settings for rhx command executions.
wrapped: false # Include (or exclude) head, header, and footer elements when enriching to HTML.
html_frontmatter: true # Include frontmatter in the rendered HTML.
markdown_frontmatter: false # Include frontmatter in Markdown drafts.
# asciidoc_frontmatter: # Include frontmatter in AsciiDoc drafts.
fetch: notes-only # What to fetch when gathering issues from API.
remove_excess_lines: 1 # Reduces N+ consecutive blank lines to N lines.
rhyml: # Settings related to RHYML data objects and documents.
markup: markdown # The markup format for the note or memo properties of RHYML objects.Liquid error: wrong number of arguments (given 3, expected 1..2)
empty_notes: skip # What to do for issues that lack a release note but have the releasenoteneeded tag (or a label otherwise declared...
empty_notes_content: RELEASE NOTE NEEDED # The content to use for empty notes when <<confpptyrhymlemptynotes>> is set to 'empty'
max_parts: 1 # The maximum number of affected part categories that can be recorded for a single change.
pasterize_summ: false # Whether to convert verbs in the summ property to past tense when drafting.
pasterize_head: false # Whether to convert verbs in the head property to past tense when drafting.
history: # Configurations for the overall document, when applicable.Liquid error: wrong number of arguments (given 3, expected 1..2)
htag: h1 # The heading level (H1, H2, etc) for the release history header.Liquid error: wrong number of arguments (given 3, expected 1..2)Liquid error: wrong number of arguments (given 3, expected 1..2)Liquid error: wrong number of arguments (given 3, expected 1..2)
items: # Settings pertaining to displayed items across Changelog and Release Notes sections.
allow_redundant: false # Whether to allow duplicate entries in a given section, for instance across groups for part:group sorts where a change affects...
show_issue_links: false # Whether to include web links in item metadata.
show_git_links: false # Whether to include git links in item metadata.
metadata_labels: before # If and where to display icons in relation to labels in item metadata.
metadata_icons: before # Whether to include icons for metadata in item metadata.
show_lead: false # Whether to include the lead-in text for the section in the item metadata.
show_type_label: false # Whether to show the type label in the item metadata output.
show_parts_label: false # Whether to show the parts label in the item metadata output.
show_tags_label: false # Whether to show the tags label in the item metadata output.
show_lead_label: false # Whether to show the lead label in the item metadata output.
show_auths_label: false # Whether to show the authors label in the item metadata output.
labeling: # Settings for labeling items in the release history output.
singularize_labels: true # Whether to singularize labels in the output when only one instance of the category is present.
type_label: type # The label to use for the type of change.
# type_icon: # The icon to use for the type of change.
parts_label: Components # The label to use for the part/component affected by the change.
part_label: Part # The label to use for the singular part/component affected by the change, when only one part is permitted.
parts_icon: puzzle-piece # The icon to use for the part/component affected by the change.
tags_label: # The tags associated with the change, if any.
- Tags
tag_label: Tag # The label to use for the singular tag associated with the change, when only one tag is permitted.
tags_icon: tags # The icon to use for the tags associated with the change.
lead_label: Contributed by # The label to use for the lead contributor of the change.
lead_icon: user # The icon to use for the lead contributor of the change.
auths_label: Contributors # The label to use for the authors of the change.
# auth_label: # The label to use for the singular author of the change, when only one author is listed and <<confpptyhistorylabelingsingularizelabels>> is...
join_string: , # The string to use to join multiple tags, parts, or authors in the output.
changelog: # The configuration for the changelog output.
head: Changelog # The header for the changelog output.Liquid error: wrong number of arguments (given 3, expected 1..2)
htag: h2 # The heading level (H1, H2, etc) for the changelog section header.
spot: 2 # Where in the document to place the changelog (1 = top, 2 = bottom).
sort: # The sort order for the changelog output.
- part:grouping1
items: # Settings that affect the frame/shape and arrangement of individual changelog entries.
frame: unordered # The layout for the changelog entry display.
allow_redundant: false # Whether to allow duplicate entries in a given section, for instance across groups for part:group sorts where a change affects...
show_git_links: false # Whether to include git links in item metadata.
show_issue_links: false # Whether to include web links in item metadata.
metadata_labels: before # If and where to display icons in relation to labels in item metadata.
metadata_icons: before # Whether to include icons for metadata in item metadata.
show_lead: false # Whether to include the lead-in text for the section in the item metadata.
show_type_label: false # Whether to show the type label in the item metadata output.
show_parts_label: false # Whether to show the parts label in the item metadata output.
show_tags_label: false # Whether to show the tags label in the item metadata output.
show_lead_label: false # Whether to show the lead label in the item metadata output.
show_auths_label: false # Whether to show the authors label in the item metadata output.
notes: # The configuration for the Release Notes listing section.
head: Release Notes # The header for the notes output.Liquid error: wrong number of arguments (given 3, expected 1..2)
htag: h2 # The heading level (H1, H2, etc) for the release notes section header.
spot: 1 # Where in the document to place the Release Notes relative to the Changelog.
sort: # The sort order for the release notes output.
- highlight:grouping1
- deprecation:grouping1
- removal:grouping1
- breaking:grouping1
- type:grouping1
- part:grouping2
items: # Settings that affect the frame/shape and arrangement of individual release-note item displays.
frame: table-cols-1 # The layout for the release-note item display.
allow_redundant: false # Whether to allow duplicate entries in a given section, for instance across groups for part:group sorts where a change affects...
show_git_links: false # Whether to include git links in item metadata.
show_issue_links: false # Whether to include web links in item metadata.
metadata_labels: before # If and where to display icons in relation to labels in item metadata.
metadata_icons: before # Whether to include icons for metadata in item metadata.
show_lead: false # Whether to include the lead-in text for the section in the item metadata.
show_type_label: false # Whether to show the type label in the item metadata output.
show_parts_label: false # Whether to show the parts label in the item metadata output.
show_tags_label: false # Whether to show the tags label in the item metadata output.
show_lead_label: false # Whether to show the lead label in the item metadata output.
show_auths_label: false # Whether to show the authors label in the item metadata output.