Skip to content

Commit 4f85a7a

Browse files
committed
Update CLAUDE.md with v0.1.34 release info and release notes guidance
1 parent 579d076 commit 4f85a7a

File tree

1 file changed

+88
-0
lines changed

1 file changed

+88
-0
lines changed

CLAUDE.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,77 @@ Before starting the release process, ensure ALL of the following are complete:
319319

320320
**Note for Claude:** Always check if the release exists before attempting to create it. The GitHub Actions workflow usually creates the release automatically as of v0.1.9, but if you get a "tag already exists" error, it means the release was already created successfully.
321321

322+
9. **Write Release Notes (Optional but Recommended)**
323+
324+
For significant releases or when requested, create a plain text release notes file:
325+
326+
```bash
327+
# Create release notes file in /tmp
328+
cat > /tmp/release-notes-vX.Y.Z.txt << 'EOF'
329+
rolfedh-doc-utils vX.Y.Z Release Notes
330+
========================================
331+
332+
Release Date: YYYY-MM-DD
333+
334+
NEW FEATURES
335+
------------
336+
337+
[Feature Name]
338+
--------------
339+
340+
[Description of the new feature with examples]
341+
342+
Example:
343+
$ command-example
344+
345+
Output:
346+
[Example output]
347+
348+
Key Behaviors:
349+
- Bullet point 1
350+
- Bullet point 2
351+
352+
DOCUMENTATION
353+
-------------
354+
355+
- Updated documentation changes
356+
- New examples added
357+
358+
INSTALLATION
359+
------------
360+
361+
Install or upgrade using pipx:
362+
363+
$ pipx install rolfedh-doc-utils
364+
$ pipx upgrade rolfedh-doc-utils
365+
366+
Or with pip:
367+
368+
$ pip install --upgrade rolfedh-doc-utils
369+
370+
COMPATIBILITY
371+
-------------
372+
373+
- Backward compatible with previous versions
374+
- No breaking changes
375+
- Default behavior unchanged
376+
377+
For complete documentation, visit:
378+
https://github.com/rolfedh/doc-utils
379+
EOF
380+
```
381+
382+
**Release Notes Guidelines:**
383+
- Use plain text format (not Markdown)
384+
- Include concrete examples with commands and output
385+
- Focus on user-facing changes and benefits
386+
- Explain key behaviors and limitations
387+
- Include upgrade/installation instructions
388+
- Note compatibility and breaking changes
389+
- Keep it concise but informative
390+
391+
**Example:** See `/tmp/release-notes-v0.1.34.txt` for the release that added definition prefix options to convert-callouts-to-deflist.
392+
322393
**Example for releasing v0.1.33:**
323394
```bash
324395
# 0. Pre-flight check - verify version.py matches intended release
@@ -529,6 +600,23 @@ When contributing to this project:
529600
530601
## Recent Improvements (Latest Refactoring)
531602
603+
### Definition Prefix Options (v0.1.34)
604+
1. **New CLI Options for convert-callouts-to-deflist**: Added prefix support for definition list format
605+
- `-s, --specifies`: Adds "Specifies " prefix before each definition
606+
- `--prefix TEXT`: Allows custom prefix text (e.g., "Indicates ", "Defines ")
607+
- Automatically adds trailing space if custom prefix doesn't have one
608+
- Works correctly with "Optional." markers (Optional appears first, then prefix)
609+
- Only applies to definition list format (ignored for bullets and comments formats)
610+
2. **Implementation**: Clean separation of concerns
611+
- Added `definition_prefix` parameter to `DefListConverter.convert()` method
612+
- Updated `CalloutConverter` to accept and pass prefix to converter
613+
- Comprehensive documentation with examples in user guides
614+
- Interactive tool intentionally does not support prefixes (batch-mode-only feature)
615+
3. **Documentation**: Updated both tool documentation pages
616+
- Added examples showing prefix usage with before/after output
617+
- Clarified that prefixes are batch-mode-only feature
618+
- Added note to interactive tool docs directing users to batch tool for prefix needs
619+
532620
### Callout Conversion Utilities (In Development)
533621
1. **New Modular Callout Library**: Created `callout_lib/` package with reusable conversion components
534622
- Shared detector module for finding and extracting callouts from AsciiDoc code blocks

0 commit comments

Comments
 (0)