releasehx 0.1.0

data/build/docs/landing.adoc

@@ -0,0 +1,21 @@
+:page-permalink: /
+:page-layout: minimal
+:page-liquid: true
+= ReleaseHx
+
+++++
+<div class="hero">
+  <div class="hero-body">
+    <div class="container">
+      <h1 class="title">
+        ReleaseHx
+      </h1>
+      <h2 class="subtitle">
+        {{ site.tagline }}
+      </h2>
+    </div>
+  </div>
+</div>
+++++
+
+include::index.adoc[tags="globals,intro,features-list"]

data/build/docs/manpage.adoc

@@ -0,0 +1,68 @@
+[[releasehx-1]]
+= releasehx(1)
+:doctype: manpage
+:manpage:
+:man-linkstyle: pass:[blue R < >]
+:toc: macro
+include::../README.adoc[tags="globals,helpscreen_attrs"]
+
+
+[[name]]
+== NAME
+
+releasehx - {tagline}
+
+*Tip:* Type `q` to exit this page.
+
+
+[[aliases]]
+== ALIASES
+
+`rhx`
+
+
+[[synopsis]]
+== SYNOPSIS
+
+[subs=quotes]
+....
+*releasehx* _VERSION_|_SOURCE_ [_OPTIONS_]
+
+*rhx* _VERSION_|_SOURCE_ [_OPTIONS_]
+....
+
+
+[[examples]]
+== EXAMPLES
+
+`rhx 1.2.3 --md`::
+Fetches and drafts Release Notes and Changelog for version 1.2.3 in Markdown.
+
+`rhx 1.2.3 --html --pdf`::
+Renders Release Notes and Changelog for version 1.2.3 from existing YAML, Markdown, or AsciiDoc draft; otherwise fetches from source and enriches directly.
+
+`rhx 1.2.3 --check`::
+Scans issues for those missing Release Notes and reports findings.
+
+`rhx release-1.2.3.md --html`::
+Renders Release Notes and Changelog for the specified Markdown file.
+
+
+[[options]]
+== OPTIONS
+
+include::../README.adoc[tags="cli_options"]
+
+// TODO: CONFIGURATION
+
+
+[[exit-status]]
+== EXIT STATUS
+
+*0*::
+Success.
+Command executed without fatal errors.
+
+*1*::
+Failure.
+Command encountered fatal error.

data/build/docs/releasehx.1

@@ -0,0 +1,281 @@
+'\" t
+.\"     Title: releasehx
+.\"    Author: [see the "AUTHOR(S)" section]
+.\" Generator: Asciidoctor 2.0.23
+.\"      Date: 2025-11-06
+.\"    Manual: \ \&
+.\"    Source: \ \&
+.\"  Language: English
+.\"
+.TH "RELEASEHX" "1" "2025-11-06" "\ \&" "\ \&"
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.ss \n[.ss] 0
+.nh
+.ad l
+.de URL
+\fI\\$2\fP <\\$1>\\$3
+..
+.als MTO URL
+.if \n[.g] \{\
+.  mso www.tmac
+.  am URL
+.    ad l
+.  .
+.  am MTO
+.    ad l
+.  .
+.  LINKSTYLE blue R < >
+.\}
+.SH "NAME"
+releasehx \- Generate formatted release histories from Jira, GitHub, GitLab, YAML, or JSON sources.
+.sp
+\fBTip:\fP Type \f(CRq\fP to exit this page.
+.SH "ALIASES"
+.sp
+\f(CRrhx\fP
+.SH "SYNOPSIS"
+.sp
+.if n .RS 4
+.nf
+.fam C
+\fBreleasehx\fP \fIVERSION\fP|\fISOURCE\fP [\fIOPTIONS\fP]
+
+\fBrhx\fP \fIVERSION\fP|\fISOURCE\fP [\fIOPTIONS\fP]
+.fam
+.fi
+.if n .RE
+.SH "EXAMPLES"
+.sp
+\f(CRrhx 1.2.3 \-\-md\fP
+.RS 4
+Fetches and drafts Release Notes and Changelog for version 1.2.3 in Markdown.
+.RE
+.sp
+\f(CRrhx 1.2.3 \-\-html \-\-pdf\fP
+.RS 4
+Renders Release Notes and Changelog for version 1.2.3 from existing YAML, Markdown, or AsciiDoc draft; otherwise fetches from source and enriches directly.
+.RE
+.sp
+\f(CRrhx 1.2.3 \-\-check\fP
+.RS 4
+Scans issues for those missing Release Notes and reports findings.
+.RE
+.sp
+\f(CRrhx release\-1.2.3.md \-\-html\fP
+.RS 4
+Renders Release Notes and Changelog for the specified Markdown file.
+.RE
+.SH "OPTIONS"
+.sp
+\fB\-\-adoc, \-\-ad\fP [\fIPATH\fP]
+.RS 4
+Draft to AsciiDoc.
+Outputs to \f(CR<drafts_dir>/<file_template>\fP or \f(CR<PATH>\fP.
+.sp
+Where \f(CR<drafts_dir>\fP is the value of \f(CRpaths.drafts_dir\fP in the config, and \f(CR<template>\fP is the value of \f(CRtemplates.drafts_filename\fP in the config.
+.RE
+.sp
+\fB\-\-api\-data\fP \fIPATH\fP
+.RS 4
+Ingest from a JSON file instead of REST response.
+Point to any local JSON source file that is formatted like a response payload for your configured API (see [conf_ppty_origin_source]); this overrides the normal REST request even if \f(CR\-\-fetch\fP is argued (though a warning will appear if you pass both options).
+.RE
+.sp
+\fB\-\-append\fP
+.RS 4
+Add any new issues to the end of local YAML source.
+.sp
+When drafting in YAML, adds new issues to the end of the file.
+Be sure to save edits before appending.
+.RE
+.sp
+\fB\-\-check, \-\-scan\fP
+.RS 4
+Find issues with missing release note.
+Scans issues for those missing release notes and reports findings.
+.RE
+.sp
+\fB\-\-config\fP \fIPATH\fP
+.RS 4
+Config location (default: ././.releasehx.yml).
+Use the configuration file at the specified path instead of the default location (\f(CR./.releasehx.yml\fP).
+.RE
+.sp
+\fB\-\-debug\fP
+.RS 4
+Express each step and show inferred states.
+Conveys all INFO and DEBUG messages.
+.RE
+.sp
+\fB\-\-debug\-dump\fP
+.RS 4
+Complete debugging with raw data.
+Includes all INFO and DEBUG output, as well as raw data objects.
+.RE
+.sp
+\fB\-\-empty, \-e\fP [\fIRULE\fP]
+.RS 4
+Set/reverse policy on issues "awaiting notes".
+.sp
+Argue a specific drafting policy, or argue the \(lqopposite\(rq policy, for handling issues that are marked as \f(CRrelease_note_needed\fP but no note is provided.
+Set a specific rule (\f(CRskip\fP, \f(CRempty\fP, \f(CRdump\fP, or \f(CRai`\fP) to have ReleaseHx include the issue when converting issues to changes, even if no expected note content has been added.
+.sp
+Using \f(CR\-e dump\fP will draft the issue with the entire issue body and commit message as the note content, for any qualifying change entry.
+Whereas \f(CR\-e ai\fP will use generative AI to draft note properties from issue body and commit message.
+.sp
+Otherwise use just \f(CR\-\-empty\fP or \f(CR\-e\fP to toggle between \f(CRskip\fP and \f(CRempty\fP, if either of those is your default in \fB[conf_ppty_rhyml_empty_notes]\fP.
+If your default is \f(CRblank\fP, \f(CRdump\fP, or \f(CRai\fP, using \f(CR\-\-empty\fP or \f(CR\-e\fP with no argument will toggle a \f(CRskip\fP policy.
+.RE
+.sp
+\fB\-\-fetch\fP
+.RS 4
+Refresh data from source.
+.sp
+Retrieves fresh data rather than using cached/draft files when converting to HTML/PDF.
+Typically used like:
+.sp
+.if n .RS 4
+.nf
+.fam C
+rhx 1.1.0 \-\-fetch \-\-html
+.fam
+.fi
+.if n .RE
+.sp
+The fetch procedure does write a cached RHYML document before generating final output.
+.RE
+.sp
+\fB\-\-frontmatter, \-\-no\-frontmatter\fP
+.RS 4
+Enrich or draft with/out frontmatter.
+When generating drafts or enriching to HTML output, \fIinclude\fP (\f(CR\-\-frontmatter\fP) or \fIexclude\fP (\f(CR\-\-no\-frontmatter\fP) frontmatter.
+.RE
+.sp
+\fB\-\-html\fP [\fIPATH\fP]
+.RS 4
+Enrich to HTML.
+Writes to \f(CR<output_path>/<file_template>\fP or \f(CR<PATH>\fP.
+.RE
+.sp
+\fB\-\-internal\fP
+.RS 4
+Include issues marked internal or likewise.
+Include issues marked as internal or similarly restricted when drafting content.
+Has no effect on enrichment operations.
+.RE
+.sp
+\fB\-\-api\-data\fP \fIPATH\fP
+.RS 4
+Ingest from a JSON file instead of REST response.
+For API responses, this option saves the payload as PATH.
+During normal output generating, this option writes a copy of RHYML object to PATH.
+.RE
+.sp
+\fB\-\-md\fP [\fIPATH\fP]
+.RS 4
+Draft to Markdown.
+Outputs to \f(CR<drafts_dir>/<file_template>\fP or \f(CR<PATH>\fP.
+.sp
+Where \f(CR<drafts_dir>\fP is the value of \f(CRpaths.drafts_dir\fP in the config, and \f(CR<template>\fP is the value of \f(CRtemplates.drafts_filename\fP in the config.
+.RE
+.sp
+\fB\-\-manpage, \-\-man\fP
+.RS 4
+Show the full manpage documentation.
+Includes this options reference and other documentation, all in the terminal.
+.if n .sp
+.RS 4
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+.B Tip
+.ps -1
+.br
+.sp
+Use \f(CRq\fP to quit back to prompt.
+.sp .5v
+.RE
+.RE
+.sp
+\fB\-\-mapping\fP
+.RS 4
+Alternate API mapping location.
+File must be a valid RHYML mapping config, usually stored at \f(CR_mapping/<apiname>.yaml\fP.
+.sp
+The mapping base directory can be changed in \fB[conf_ppty_paths_mappings_dir]\fP, but this option must include a complete relative or absolute path.
+.RE
+.sp
+\fB\-\-payload\fP [\fIPATH\fP]
+.RS 4
+Store payload as JSON file at PATH or default
+If no path is argued, defaults to that set in \fB[conf_ppty_paths_payloads_dir]\fP.
+.RE
+.sp
+\fB\-\-output\-dir\fP \fIDIRECTORY\fP
+.RS 4
+Establish base target path for generated files.
+.RE
+.sp
+\fB\-\-over, \-\-force\fP
+.RS 4
+Overwrite any existing files without prompting.
+When writing files, overwrite existing files without prompting for confirmation.
+.RE
+.sp
+\fB\-\-pdf\fP [\fIPATH\fP]
+.RS 4
+Enriches to PDF from default or designated source.
+Writes to \f(CR<output_path>/<file_template>\fP or \f(CR<PATH>\fP.
+.RE
+.sp
+\fB\-\-scan, \-\-check\fP
+.RS 4
+Find issues with missing release note.
+Scans issues for those missing release notes and reports findings..
+.RE
+.sp
+\fB\-\-verbose\fP
+.RS 4
+Express each step to console during execution.
+.RE
+.sp
+\fB\-\-version\fP
+.RS 4
+Display the ReleaseHx version code.
+.RE
+.sp
+\fB\-\-wrap, \-\-no\-wrap\fP
+.RS 4
+Enrich HTML with/out head and body tags.
+When enriching to HTML, \fIinclude\fP (\f(CR\-\-wrap\fP) or \fIexclude\fP (\f(CR\-\-no\-wrap\fP) the \f(CR<head>\fP and \f(CR<body>\fP tags and their content.
+For use when the opposite value is set in the config file (\fB[conf_ppty_modes_wrapped]\fP).
+.RE
+.sp
+\fB\-\-quiet\fP
+.RS 4
+Suppress all output, including warnings.
+.RE
+.sp
+\fB\-\-yaml, \-\-yml\fP [\fIPATH\fP]
+.RS 4
+Draft to YAML.
+Outputs to \f(CR<drafts_dir>/<file_template>\fP or \f(CR<PATH>\fP.
+.sp
+Where \f(CR<drafts_dir>\fP is the value of \f(CRpaths.drafts_dir\fP in the config, and \f(CR<template>\fP is the value of \f(CRtemplates.drafts_filename\fP in the config.
+.RE
+.SH "EXIT STATUS"
+.sp
+\fB0\fP
+.RS 4
+Success.
+Command executed without fatal errors.
+.RE
+.sp
+\fB1\fP
+.RS 4
+Failure.
+Command encountered fatal error.
+.RE