Files

T

diodiogod c88b223144 Major README.md redesign and version management automation

README.md improvements:
- Remove template boilerplate and unused badge references
- Reorganize content with clear 'What's New' section highlighting v3.0+ features
- Add 5-minute Quick Start guide for immediate setup
- Replace text workflow examples with real downloadable files
- Add workflow placeholders for Audio Wave Analyzer + F5 Speech Edit workflows
- Fix SRT_IMPLEMENTATION.md path reference
- Better visual hierarchy and professional structure

Version management automation:
- Add automated version bumping scripts with multiline support
- Create comprehensive version management guide
- Support interactive mode, file input, and detailed changelog generation
- Automatic categorization of changelog entries (Added/Fixed/Changed/Removed)
- Rollback protection and validation
- Update CLAUDE.md to reference external documentation (token optimization)

2025-07-14 11:09:33 -03:00

2.0 KiB

Raw Permalink Blame History

Version Update Guide

This guide explains how to update the version number across the ChatterBox Voice Extension.

Files to Update

When updating the version, you need to update these 6 files:

1. README.md

Update the title: # ComfyUI_ChatterBox_Voice v2.0.0

2. CHANGELOG.md

Add new version entry at the top with date and changes

3. nodes.py

Update VERSION = "2.0.0"
Set IS_DEV = False for release builds, True for development

4. pyproject.toml

Update version = "2.0.0" in the [project] section

5. srt/init.py

Update __version__ = "2.0.0"

6. core/init.py

Update __version__ = "2.0.0"

Automated Version Update Process (RECOMMENDED)

Using the Automation Script

Always use the automated script for version updates:

python3 scripts/bump_version.py <version> "<description>"

Examples:

# Bug fix
python3 scripts/bump_version.py 3.0.2 "Fix missing sounddevice dependency"

# New feature
python3 scripts/bump_version.py 3.1.0 "Add audio waveform visualization"

# Breaking change
python3 scripts/bump_version.py 4.0.0 "Restructure API for better compatibility"

Options:

--dry-run: Preview changes without making them
--no-commit: Update files but don't commit to git

What the Script Does Automatically

Validates version format (semantic versioning)
Updates all 6 files with the new version number
Adds changelog entry with date and description
Commits changes with proper message format
Provides rollback if anything fails

Manual Version Update Process (FALLBACK ONLY)

⚠️ Only use this if the automated script fails

Update the 6 files above with the new version number
Update CHANGELOG.md with the new version entry and release notes
Set IS_DEV flag appropriately in nodes.py:
- IS_DEV = False for release builds
- IS_DEV = True for development builds
Test the changes to ensure everything works
Commit and tag the release

Current Version: 3.0.1

Last updated: 2025-07-14

2.0 KiB Raw Permalink Blame History