2.9 KiB
2.9 KiB
Deployment Guide
Quick instructions for deploying a new version of the Text Texture Generator addon.
Prerequisites
- Git repository with proper tags
- Python 3.10+
- All changes committed and pushed to main branch
Deployment Steps
1. Create Version Tag
# Create and push a version tag
git tag v1.1.0
git push origin v1.1.0
2. Generate Changelog (Optional)
# Generate changelog for the new version
python3 build/generate_changelog.py --version 1.1.0 --output CHANGELOG_v1.1.0.md
# Or generate full changelog
python3 build/generate_changelog.py --full --output CHANGELOG.md
3. Build Packages
# Build both versions (recommended)
python3 scripts/build_addon.py --type all --version 1.1.0
# Or build individually:
# python3 scripts/build_addon.py --type full --version 1.1.0
# python3 scripts/build_addon.py --type free --version 1.1.0
4. Validate Packages
# Validate the generated packages
python3 build/validate_package.py dist/text_texture_generator_v1.1.0.zip --type full
python3 build/validate_package.py dist/text_texture_generator_v1.1.0_free.zip --type free
5. Deploy
Upload the validated packages from the dist/ directory:
text_texture_generator_v1.1.0.zip(Full version)text_texture_generator_v1.1.0_free.zip(Free version)
Build System Overview
The deployment uses a sophisticated build-time file exclusion system:
- Version Sync:
sync_version.pyautomatically updates version information from git tags - Package Build:
build_addon.pycreates separate packages with different feature sets - Validation:
validate_package.pyensures package integrity - Changelog:
generate_changelog.pycreates release notes from git history
Configuration Files
build/config.json- Project metadata and build settingsbuild/file_exclusions.json- Defines which files are excluded from free builds
Troubleshooting
No Git Tags Found
If version sync fails, ensure you have created and pushed the version tag:
git tag -l # List existing tags
git tag v1.1.0 # Create new tag
git push origin v1.1.0 # Push to remote
Build Validation Fails
Check the validation output for specific errors:
python3 build/validate_package.py dist/your_package.zip --type full
Version Mismatch
The build system automatically syncs versions from git tags. If you need to override:
python3 build/sync_version.py --version 1.1.0 --type full
Quick Deploy Command
For experienced users, deploy in one command:
git tag v1.1.0 && git push origin v1.1.0 && python3 scripts/build_addon.py --type all --version 1.1.0 && python3 build/validate_package.py dist/text_texture_generator_v1.1.0.zip && python3 build/validate_package.py dist/text_texture_generator_v1.1.0_free.zip