Skip to content

Commit 97fe012

Browse files
Merge pull request for 0.1.2 release
2 parents 5af89aa + 8278eb6 commit 97fe012

32 files changed

Lines changed: 753 additions & 291 deletions

.config/docopslab-dev.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@ tools:
4747
paths:
4848
skip:
4949
- build/*
50+
- specs/*
51+
- "**/config-reference.adoc"
52+
- docs/releases.adoc
53+
- docs/release/*
5054

5155
- tool: htmlproofer
5256
enabled: true # Disabled by default, enable per project

.config/releasehx.yml

Lines changed: 182 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
# ReleaseHx configuration for DocOps/releasehx repository
2+
# Self-dogfooding configuration to manage ReleaseHx's own release history
3+
4+
origin:
5+
source: github
6+
project: DocOps/releasehx
7+
version: 3
8+
label: GitHub Issues API v3
9+
format: json
10+
11+
paths:
12+
drafts_dir: docs/release/drafts
13+
payloads_dir: docs/release/payloads
14+
templates_dir: docs/release/templates
15+
mappings_dir: docs/release/mappings
16+
17+
conversions:
18+
summ: issue_heading
19+
note: issue_body
20+
note_pattern: |
21+
/^(((#|=)+ (Draft )?Release Note.*?)|(<!-- (draft )?release note -->))\n+(?<note>(.|)+)/gmi
22+
markup: markdown
23+
24+
rhyml:
25+
pasterize_summ: true
26+
pasterize_head: true
27+
chid: "{{ release.code | replace: '.', '_' | upcase }}-{{ change.tick }}"
28+
empty_notes: skip
29+
30+
parts:
31+
label_prefix: "component:"
32+
cli:
33+
text: CLI
34+
head: CLI
35+
icon: terminal
36+
api:
37+
text: API
38+
head: API
39+
icon: code
40+
docs:
41+
text: documentation
42+
head: Documentation
43+
icon: book
44+
mcp:
45+
text: MCP Server
46+
head: MCP Server
47+
icon: plug
48+
templates:
49+
text: templates
50+
head: Templates
51+
icon: file-text-o
52+
rhyml:
53+
text: RHYML
54+
head: RHYML
55+
icon: file-code-o
56+
schemagraphy:
57+
text: SchemaGraphy
58+
head: SchemaGraphy
59+
icon: sitemap
60+
configuration:
61+
text: configuration
62+
head: Configuration
63+
icon: cogs
64+
65+
types:
66+
label_prefix: "type:"
67+
feature:
68+
slug: feature
69+
text: new feature
70+
head: Added
71+
icon: plus-square-o
72+
bug:
73+
slug: bug
74+
text: bug fix
75+
head: Fixed
76+
icon: bug
77+
improvement:
78+
slug: improvement
79+
text: improvement
80+
head: Improved
81+
icon: wrench
82+
documentation:
83+
slug: documentation
84+
text: documentation
85+
head: Documentation
86+
icon: book
87+
removal:
88+
slug: removal
89+
text: removal
90+
head: Removed
91+
icon: exclamation-triangle
92+
deprecation:
93+
slug: deprecation
94+
text: deprecation
95+
head: Deprecated
96+
icon: exclamation-circle
97+
98+
tags:
99+
# Include all tags by default for 0.1.2 (no filtering)
100+
# _include: ['highlight', 'changelog', 'breaking', 'deprecation', 'experimental']
101+
# _exclude: ['internal', 'wontfix', 'duplicate', 'invalid']
102+
103+
highlight:
104+
head: Highlights
105+
icon: star
106+
text: Featured changes
107+
108+
breaking:
109+
head: Breaking Changes
110+
icon: exclamation-triangle
111+
text: Breaking changes
112+
113+
deprecation:
114+
head: Deprecations
115+
icon: clock-o
116+
text: Deprecated features
117+
118+
experimental:
119+
head: Experimental Features
120+
icon: flask
121+
text: Experimental features
122+
123+
# Pass-through tags for labels not explicitly configured
124+
documentation:
125+
slug: documentation
126+
changelog:
127+
slug: changelog
128+
129+
links:
130+
web: https://github.com/DocOps/releasehx/issues/{{ tick }}
131+
git: https://github.com/DocOps/releasehx/commit/{{ hash }}
132+
usr: https://github.com/{{ vars.lead }}
133+
134+
modes:
135+
asciidoc_frontmatter: true
136+
markdown_frontmatter: false
137+
remove_excess_lines: 2
138+
139+
history:
140+
items:
141+
issue_links: true
142+
git_links: false
143+
metadata_icons: true
144+
145+
# Changelog section configuration
146+
changelog:
147+
head: What's Changed
148+
text: Summary of all changes in this release.
149+
htag: h2
150+
spot: 1
151+
sort:
152+
- breaking:grouping1
153+
- type:grouping1
154+
items:
155+
frame: unordered
156+
allow_redundant: false
157+
show_issue_links: true
158+
metadata_labels: before
159+
metadata_icons: before
160+
show_parts_label: true
161+
show_tags_label: false
162+
show_type_label: false
163+
show_lead_label: false
164+
165+
# Release notes section configuration
166+
notes:
167+
head: Release Notes
168+
text: Detailed descriptions of notable changes.
169+
htag: h2
170+
spot: 2
171+
sort:
172+
- type:grouping1
173+
items:
174+
frame: table-cols-1
175+
allow_redundant: true
176+
show_issue_links: true
177+
metadata_labels: before
178+
metadata_icons: before
179+
show_parts_label: true
180+
show_tags_label: true
181+
show_type_label: true
182+
show_lead_label: true

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,3 +80,7 @@ repomix-output.xml
8080
# Local development directories
8181
dev/
8282
releasehx-demo/
83+
84+
# Release history working directories
85+
docs/release/drafts/
86+
docs/release/payloads/

Gemfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ end
1717
group :documentation do
1818
gem 'jekyll'
1919
gem 'jekyll-asciidoc'
20+
gem 'jekyll-redirect-from'
2021
gem 'just-the-docs'
2122
gem 'yard'
2223
end

Gemfile.lock

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PATH
22
remote: .
33
specs:
4-
releasehx (0.1.0)
4+
releasehx (0.1.2)
55
asciidoctor-pdf (~> 2.3)
66
commonmarker (~> 0.23)
77
faraday (~> 2.9)
@@ -188,6 +188,8 @@ GEM
188188
jekyll (>= 3.0.0)
189189
jekyll-include-cache (0.2.1)
190190
jekyll (>= 3.7, < 5.0)
191+
jekyll-redirect-from (0.16.0)
192+
jekyll (>= 3.3, < 5.0)
191193
jekyll-sass-converter (3.1.0)
192194
sass-embedded (~> 1.75)
193195
jekyll-seo-tag (2.8.0)
@@ -370,6 +372,7 @@ DEPENDENCIES
370372
docopslab-dev
371373
jekyll
372374
jekyll-asciidoc
375+
jekyll-redirect-from
373376
just-the-docs
374377
releasehx!
375378
rspec (~> 3.0)

README.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
:page-layout: default
2-
:page-permalink: /docs
2+
:page-permalink: /docs/
3+
:page-title: ReleaseHx Docs
34
:page-nav_order: 1
45
[[releasehx]]
56
= ReleaseHx
@@ -15,7 +16,7 @@
1516
:this_prod_vrsn_major: 0
1617
:this_prod_vrsn_minor: 1
1718
:this_prod_vrsn_major-minor: {this_prod_vrsn_major}.{this_prod_vrsn_minor}
18-
:this_prod_vrsn_patch: 1
19+
:this_prod_vrsn_patch: 2
1920
:this_prod_vrsn: {this_prod_vrsn_major-minor}.{this_prod_vrsn_patch}
2021
:next_prod_vrsn: 0.2.0
2122
:tagline: Generate formatted release histories from Jira, GitHub, GitLab, YAML, or JSON sources.
@@ -2475,6 +2476,7 @@ Use `PORT=NNNN` environment argument to specify a different port.
24752476
[.prompt]
24762477
PORT=4000 bundle exec rake serve
24772478

2479+
[[docopslab-devtool]]
24782480
==== DocOps Lab Devtool (`docopslab-dev`)
24792481

24802482
Special dev Rake tasks and libraries are available via the `docopslab-dev` gem.

0 commit comments

Comments
 (0)