Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .config/docopslab-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@ tools:
paths:
skip:
- build/*
- specs/*
- "**/config-reference.adoc"
- docs/releases.adoc
- docs/release/*

- tool: htmlproofer
enabled: true # Disabled by default, enable per project
Expand Down
182 changes: 182 additions & 0 deletions .config/releasehx.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
# ReleaseHx configuration for DocOps/releasehx repository
# Self-dogfooding configuration to manage ReleaseHx's own release history

origin:
source: github
project: DocOps/releasehx
version: 3
label: GitHub Issues API v3
format: json

paths:
drafts_dir: docs/release/drafts
payloads_dir: docs/release/payloads
templates_dir: docs/release/templates
mappings_dir: docs/release/mappings

conversions:
summ: issue_heading
note: issue_body
note_pattern: |
/^(((#|=)+ (Draft )?Release Note.*?)|(<!-- (draft )?release note -->))\n+(?<note>(.|)+)/gmi
markup: markdown

rhyml:
pasterize_summ: true
pasterize_head: true
chid: "{{ release.code | replace: '.', '_' | upcase }}-{{ change.tick }}"
empty_notes: skip

parts:
label_prefix: "component:"
cli:
text: CLI
head: CLI
icon: terminal
api:
text: API
head: API
icon: code
docs:
text: documentation
head: Documentation
icon: book
mcp:
text: MCP Server
head: MCP Server
icon: plug
templates:
text: templates
head: Templates
icon: file-text-o
rhyml:
text: RHYML
head: RHYML
icon: file-code-o
schemagraphy:
text: SchemaGraphy
head: SchemaGraphy
icon: sitemap
configuration:
text: configuration
head: Configuration
icon: cogs

types:
label_prefix: "type:"
feature:
slug: feature
text: new feature
head: Added
icon: plus-square-o
bug:
slug: bug
text: bug fix
head: Fixed
icon: bug
improvement:
slug: improvement
text: improvement
head: Improved
icon: wrench
documentation:
slug: documentation
text: documentation
head: Documentation
icon: book
removal:
slug: removal
text: removal
head: Removed
icon: exclamation-triangle
deprecation:
slug: deprecation
text: deprecation
head: Deprecated
icon: exclamation-circle

tags:
# Include all tags by default for 0.1.2 (no filtering)
# _include: ['highlight', 'changelog', 'breaking', 'deprecation', 'experimental']
# _exclude: ['internal', 'wontfix', 'duplicate', 'invalid']

highlight:
head: Highlights
icon: star
text: Featured changes

breaking:
head: Breaking Changes
icon: exclamation-triangle
text: Breaking changes

deprecation:
head: Deprecations
icon: clock-o
text: Deprecated features

experimental:
head: Experimental Features
icon: flask
text: Experimental features

# Pass-through tags for labels not explicitly configured
documentation:
slug: documentation
changelog:
slug: changelog

links:
web: https://github.com/DocOps/releasehx/issues/{{ tick }}
git: https://github.com/DocOps/releasehx/commit/{{ hash }}
usr: https://github.com/{{ vars.lead }}

modes:
asciidoc_frontmatter: true
markdown_frontmatter: false
remove_excess_lines: 2

history:
items:
issue_links: true
git_links: false
metadata_icons: true

# Changelog section configuration
changelog:
head: What's Changed
text: Summary of all changes in this release.
htag: h2
spot: 1
sort:
- breaking:grouping1
- type:grouping1
items:
frame: unordered
allow_redundant: false
show_issue_links: true
metadata_labels: before
metadata_icons: before
show_parts_label: true
show_tags_label: false
show_type_label: false
show_lead_label: false

# Release notes section configuration
notes:
head: Release Notes
text: Detailed descriptions of notable changes.
htag: h2
spot: 2
sort:
- type:grouping1
items:
frame: table-cols-1
allow_redundant: true
show_issue_links: true
metadata_labels: before
metadata_icons: before
show_parts_label: true
show_tags_label: true
show_type_label: true
show_lead_label: true
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,7 @@ repomix-output.xml
# Local development directories
dev/
releasehx-demo/

# Release history working directories
docs/release/drafts/
docs/release/payloads/
1 change: 1 addition & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ end
group :documentation do
gem 'jekyll'
gem 'jekyll-asciidoc'
gem 'jekyll-redirect-from'
gem 'just-the-docs'
gem 'yard'
end
5 changes: 4 additions & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
releasehx (0.1.0)
releasehx (0.1.2)
asciidoctor-pdf (~> 2.3)
commonmarker (~> 0.23)
faraday (~> 2.9)
Expand Down Expand Up @@ -188,6 +188,8 @@ GEM
jekyll (>= 3.0.0)
jekyll-include-cache (0.2.1)
jekyll (>= 3.7, < 5.0)
jekyll-redirect-from (0.16.0)
jekyll (>= 3.3, < 5.0)
jekyll-sass-converter (3.1.0)
sass-embedded (~> 1.75)
jekyll-seo-tag (2.8.0)
Expand Down Expand Up @@ -370,6 +372,7 @@ DEPENDENCIES
docopslab-dev
jekyll
jekyll-asciidoc
jekyll-redirect-from
just-the-docs
releasehx!
rspec (~> 3.0)
Expand Down
6 changes: 4 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
:page-layout: default
:page-permalink: /docs
:page-permalink: /docs/
:page-title: ReleaseHx Docs
:page-nav_order: 1
[[releasehx]]
= ReleaseHx
Expand All @@ -15,7 +16,7 @@
:this_prod_vrsn_major: 0
:this_prod_vrsn_minor: 1
:this_prod_vrsn_major-minor: {this_prod_vrsn_major}.{this_prod_vrsn_minor}
:this_prod_vrsn_patch: 1
:this_prod_vrsn_patch: 2
:this_prod_vrsn: {this_prod_vrsn_major-minor}.{this_prod_vrsn_patch}
:next_prod_vrsn: 0.2.0
:tagline: Generate formatted release histories from Jira, GitHub, GitLab, YAML, or JSON sources.
Expand Down Expand Up @@ -2475,6 +2476,7 @@ Use `PORT=NNNN` environment argument to specify a different port.
[.prompt]
PORT=4000 bundle exec rake serve

[[docopslab-devtool]]
==== DocOps Lab Devtool (`docopslab-dev`)

Special dev Rake tasks and libraries are available via the `docopslab-dev` gem.
Expand Down
Loading