Complete release history for ReleaseHx, generated using ReleaseHx itself.

Release History

0.2.1

28 May, 2026

0.2.0

27 May, 2026

0.1.2

30 January, 2026

Release History — 0.2.1 - 2026-05-28

What’s Changed

Summary of all changes in this release.

Fixed

  • Fixed broken YAML output when changes contain notes
    NOTE

Release Notes

Detailed descriptions of notable changes.

Fixed

The rhyml-change.yaml.liquid template contained four defects introduced in 0.2.0 that caused Liquid error: internal followed by a YAML SyntaxError whenever a change entry included a release note.

Specifically:

  • _note was referenced as a variable but never defined (should be change.note)

  • summ: key was output at column 0 instead of the required 2-space indent

  • part: key was indented 4 spaces instead of 2

  • .strip was applied as a Liquid filter, which is not valid Liquid syntax

All four are corrected. Any configuration that includes conversions.note (Jira, GitHub, GitLab, or RHYML sources with note content) is affected by this bug and should upgrade to 0.2.1.

Release History — 0.2.0 - 2026-05-27

What’s Changed

Summary of all changes in this release.

Breaking Changes

  • Radically upgraded template designs
    NOTE

Fixed

  • Adapter now honors documented config settings for extracting release notes
    NOTE

  • Addressed Liquid errors in the generated sample-config file
    NOTE

  • Fixed payload pre-extraction that interfered with custom --mapping files
    NOTE

Improved

  • Radically upgraded template designs
    NOTE

Removed

  • Removed SchemaGraphy module in favor of external schemagraphy gem
    NOTE

  • Removed Sourcerer module code in favor of asciisourcerer gem
    NOTE

Release Notes

Detailed descriptions of notable changes.

Fixed

The adapter was reading an internal legacy property (sources.note_source) rather than the documented conversions.note setting, causing note extraction to fail silently. The default note_pattern regex also used a greedy quantifier that consumed the entire issue body when multiple heading formats were specified.

Both are now fixed: the adapter reads conversions.note (with a backward-compatible fallback to note_source), and the default pattern uses a non-greedy match.

The pre-build produced a YAML file containing literal Liquid error strings due to template defects in the cfgyml template layer. These have been corrected.

When using --mapping with a custom mapping file, the CLI was pre-extracting the issues array from the API payload before passing it to the adapter. Custom mappings define their own changes_array_path and expect the full payload structure from the root. This caused failures with Jira description-based mappings and any other custom mapping that traverses from the payload root.

Improved

Substantial redesign of HTML, Markdown, and AsciiDoc output templates, with a new configurable styling system.

HTML output now renders with Bootstrap 5 components and semantic HTML5 markup. Styling is configurable via history.styling.*: choose between framework, embedded, external, or minimal CSS modes, with dark theme and print style support.

Breaking changes:

  • modes.wrapped renamed to modes.html_wrap

  • conversions.engine replaced by conversions.engines.html and conversions.engines.pdf

  • The default ordering of notes.spot and changelog.spot is swapped; Changelog now appears before Notes

Removed

The SchemaGraphy module has been extracted from releasehx and published as the schemagraphy gem on RubyGems.

Now releasehx adds schemagraphy as a runtime dependency, so no change is needed for CLI users. Downstream gem users who rely on individualized SchemaGraphy classes directly should require schemagraphy and/or its modules explicitly and invoke through such paths.

This note applies only to downstream developers who embed the releasehx gem as a dependency.

The Sourcerer module has been extracted and published as the asciisourcerer gem on RubyGems (the sourcerer name was taken by an unrelated project). Downstream dependencies should add asciisourcerer` explicitly if they rely on the Sourcerer API.

Release History — 0.1.2 - 2026-01-30

What’s Changed

Summary of all changes in this release.

Added

  • Establish an instance of ReleaseHx for managing the release history of…​ ReleaseHx (dog fooding!)
    NOTE

Fixed

  • Formatting errors in AsciiDoc templates
    NOTE

  • Documented regexp format (/pattern/flags) unsupported
    NOTE

  • Config property mismatch: code reads note_source but docs specify note
    NOTE

  • Erroneous fetch attempted even when file path is provided as first argument

Improved

  • Move all docs under /docs URL path
    NOTE

Release Notes

Detailed descriptions of notable changes.

Added

The ReleaseHx website now hosts a rich-text roster of change reports built with ReleaseHx itself at https://releasehx.docopslab.org/docs/releases/. The output is configured in .config/releasehx.yml, and the process is documented in README.adoc.

Fixed

AsciiDoc templates have been cleaned up and streamlined significantly, mostly by removing the clumsy metadata that was hard to style in rich-text output. We will improve on these templates later and welcome contributions cleaning them up.

Regular expressions in YAML files such as the releasehx application config now support being written as fully qualified strings with the pattern fenced in / markers. Use /pattern/flags formats such as the following and expect proper parsing.

  note_pattern: /^((#+ Draft Release Note.*?)\n+(?<note>(.|)+)/gmi

Added support for a proper configuration property for release-note extraction, bringing the product into line with the documented config. The effective property was never documented, so it has been removed, but no deprecation was deemed necessary. Backward compatibility has been sacrificed in this rare case, since the functionality was obscured.

Improved

Fixed and redirected all documentation URLs and new releases URL to be relative to https://releasehx.docopslab.org/docs/.

For more information about ReleaseHx, see the main documentation.