You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CLAUDE.md
+88Lines changed: 88 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -319,6 +319,77 @@ Before starting the release process, ensure ALL of the following are complete:
319
319
320
320
**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.
321
321
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.
0 commit comments