Spaces:
Paused
Paused
File size: 15,732 Bytes
fb867c3 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 |
#!/usr/bin/env python3
"""
Semantic versioning and release management for Felix Framework.
Handles version tagging, changelog generation, and deployment coordination.
"""
import os
import sys
import json
import re
import subprocess
from pathlib import Path
from typing import Dict, List, Tuple, Optional, Any
from datetime import datetime
from enum import Enum
class VersionType(Enum):
"""Version increment types."""
MAJOR = "major"
MINOR = "minor"
PATCH = "patch"
PRERELEASE = "prerelease"
class ReleaseType(Enum):
"""Release channel types."""
ALPHA = "alpha"
BETA = "beta"
RC = "rc"
STABLE = "stable"
def load_version_file() -> Dict[str, Any]:
"""Load current version from VERSION.json."""
version_file = Path(__file__).parent.parent / "VERSION.json"
if not version_file.exists():
# Create default version file
default_version = {
"version": "0.1.0",
"version_info": {"major": 0, "minor": 1, "patch": 0, "pre_release": None, "build_metadata": None},
"release_name": "Initial Release",
"release_date": datetime.now().strftime("%Y-%m-%d"),
"changelog": "Initial Felix Framework release",
"compatibility": {"python": ">=3.11"},
"deployment": {"hf_spaces_ready": False, "docker_ready": False},
"features": []
}
save_version_file(default_version)
return default_version
with open(version_file, 'r') as f:
return json.load(f)
def save_version_file(version_data: Dict[str, Any]) -> None:
"""Save version data to VERSION.json."""
version_file = Path(__file__).parent.parent / "VERSION.json"
with open(version_file, 'w') as f:
json.dump(version_data, f, indent=2)
def parse_semantic_version(version_str: str) -> Dict[str, Any]:
"""Parse semantic version string into components."""
# Pattern: MAJOR.MINOR.PATCH[-PRERELEASE][+BUILD]
pattern = r'^(\d+)\.(\d+)\.(\d+)(?:-([a-zA-Z0-9\-\.]+))?(?:\+([a-zA-Z0-9\-\.]+))?$'
match = re.match(pattern, version_str)
if not match:
raise ValueError(f"Invalid semantic version format: {version_str}")
return {
"major": int(match.group(1)),
"minor": int(match.group(2)),
"patch": int(match.group(3)),
"pre_release": match.group(4),
"build_metadata": match.group(5)
}
def format_semantic_version(version_info: Dict[str, Any]) -> str:
"""Format version components into semantic version string."""
version = f"{version_info['major']}.{version_info['minor']}.{version_info['patch']}"
if version_info.get('pre_release'):
version += f"-{version_info['pre_release']}"
if version_info.get('build_metadata'):
version += f"+{version_info['build_metadata']}"
return version
def increment_version(current_version: Dict[str, Any], version_type: VersionType,
prerelease_type: Optional[ReleaseType] = None) -> Dict[str, Any]:
"""Increment version based on type."""
version_info = current_version['version_info'].copy()
if version_type == VersionType.MAJOR:
version_info['major'] += 1
version_info['minor'] = 0
version_info['patch'] = 0
version_info['pre_release'] = None
elif version_type == VersionType.MINOR:
version_info['minor'] += 1
version_info['patch'] = 0
version_info['pre_release'] = None
elif version_type == VersionType.PATCH:
version_info['patch'] += 1
version_info['pre_release'] = None
elif version_type == VersionType.PRERELEASE:
if not prerelease_type:
prerelease_type = ReleaseType.ALPHA
current_pre = version_info.get('pre_release', '')
if current_pre:
# Increment existing prerelease
if prerelease_type.value in current_pre:
parts = current_pre.split('.')
if len(parts) == 2 and parts[1].isdigit():
parts[1] = str(int(parts[1]) + 1)
version_info['pre_release'] = '.'.join(parts)
else:
version_info['pre_release'] = f"{prerelease_type.value}.1"
else:
version_info['pre_release'] = f"{prerelease_type.value}.1"
else:
# First prerelease
version_info['pre_release'] = f"{prerelease_type.value}.1"
# Update build metadata with timestamp
version_info['build_metadata'] = datetime.now().strftime("%Y%m%d%H%M%S")
# Create new version data
new_version = current_version.copy()
new_version['version_info'] = version_info
new_version['version'] = format_semantic_version(version_info)
new_version['release_date'] = datetime.now().strftime("%Y-%m-%d")
return new_version
def get_commit_messages_since_tag(tag: str) -> List[str]:
"""Get commit messages since the specified tag."""
try:
result = subprocess.run([
'git', 'log', f'{tag}..HEAD', '--oneline', '--no-merges'
], capture_output=True, text=True, cwd=Path(__file__).parent.parent)
if result.returncode == 0:
return [line.strip() for line in result.stdout.strip().split('\n') if line.strip()]
else:
return []
except Exception:
return []
def get_latest_git_tag() -> Optional[str]:
"""Get the latest git tag."""
try:
result = subprocess.run([
'git', 'describe', '--tags', '--abbrev=0'
], capture_output=True, text=True, cwd=Path(__file__).parent.parent)
if result.returncode == 0:
return result.stdout.strip()
else:
return None
except Exception:
return None
def categorize_commits(commits: List[str]) -> Dict[str, List[str]]:
"""Categorize commits by type using conventional commit format."""
categories = {
'features': [],
'fixes': [],
'docs': [],
'style': [],
'refactor': [],
'perf': [],
'test': [],
'chore': [],
'ci': [],
'breaking': [],
'other': []
}
# Conventional commit patterns
patterns = {
'features': r'^feat(\(.+\))?!?:',
'fixes': r'^fix(\(.+\))?!?:',
'docs': r'^docs(\(.+\))?!?:',
'style': r'^style(\(.+\))?!?:',
'refactor': r'^refactor(\(.+\))?!?:',
'perf': r'^perf(\(.+\))?!?:',
'test': r'^test(\(.+\))?!?:',
'chore': r'^chore(\(.+\))?!?:',
'ci': r'^ci(\(.+\))?!?:',
'breaking': r'!:'
}
for commit in commits:
# Remove hash prefix if present
if ' ' in commit:
commit_msg = commit.split(' ', 1)[1]
else:
commit_msg = commit
categorized = False
# Check for breaking changes first
if re.search(patterns['breaking'], commit_msg):
categories['breaking'].append(commit_msg)
categorized = True
# Check other categories
for category, pattern in patterns.items():
if category != 'breaking' and re.search(pattern, commit_msg, re.IGNORECASE):
categories[category].append(commit_msg)
categorized = True
break
if not categorized:
categories['other'].append(commit_msg)
return categories
def generate_changelog(current_version: Dict[str, Any], new_version: Dict[str, Any]) -> str:
"""Generate changelog for the new version."""
changelog = f"# Changelog for v{new_version['version']}\n\n"
changelog += f"**Release Date**: {new_version['release_date']}\n"
changelog += f"**Release Name**: {new_version.get('release_name', 'Unnamed Release')}\n\n"
# Get commits since last tag
latest_tag = get_latest_git_tag()
if latest_tag:
commits = get_commit_messages_since_tag(latest_tag)
else:
# First release
commits = get_commit_messages_since_tag("HEAD~100") # Last 100 commits
if commits:
categorized = categorize_commits(commits)
# Breaking changes first
if categorized['breaking']:
changelog += "## π¨ Breaking Changes\n\n"
for commit in categorized['breaking']:
changelog += f"- {commit}\n"
changelog += "\n"
# Features
if categorized['features']:
changelog += "## β¨ New Features\n\n"
for commit in categorized['features']:
changelog += f"- {commit}\n"
changelog += "\n"
# Bug fixes
if categorized['fixes']:
changelog += "## π Bug Fixes\n\n"
for commit in categorized['fixes']:
changelog += f"- {commit}\n"
changelog += "\n"
# Performance improvements
if categorized['perf']:
changelog += "## β‘ Performance Improvements\n\n"
for commit in categorized['perf']:
changelog += f"- {commit}\n"
changelog += "\n"
# Documentation
if categorized['docs']:
changelog += "## π Documentation\n\n"
for commit in categorized['docs']:
changelog += f"- {commit}\n"
changelog += "\n"
# Other changes
other_categories = ['refactor', 'style', 'test', 'chore', 'ci', 'other']
other_commits = []
for category in other_categories:
other_commits.extend(categorized[category])
if other_commits:
changelog += "## π§ Other Changes\n\n"
for commit in other_commits:
changelog += f"- {commit}\n"
changelog += "\n"
# Add deployment information
if new_version.get('deployment', {}).get('hf_spaces_ready'):
changelog += "## π Deployment\n\n"
changelog += "- β
Ready for HuggingFace Spaces deployment\n"
if new_version['deployment'].get('zerogpu_optimized'):
changelog += "- β‘ ZeroGPU acceleration enabled\n"
if new_version['deployment'].get('docker_ready'):
changelog += "- π³ Docker containerization ready\n"
changelog += "\n"
# Add compatibility information
if new_version.get('compatibility'):
changelog += "## π Compatibility\n\n"
for requirement, version in new_version['compatibility'].items():
changelog += f"- **{requirement}**: {version}\n"
changelog += "\n"
return changelog
def create_git_tag(version: str, changelog: str) -> bool:
"""Create and push git tag for the release."""
try:
# Create annotated tag
tag_name = f"v{version}"
tag_message = f"Felix Framework {version}\n\n{changelog[:500]}..."
result = subprocess.run([
'git', 'tag', '-a', tag_name, '-m', tag_message
], capture_output=True, text=True, cwd=Path(__file__).parent.parent)
if result.returncode != 0:
print(f"Failed to create tag: {result.stderr}")
return False
# Push tag
result = subprocess.run([
'git', 'push', 'origin', tag_name
], capture_output=True, text=True, cwd=Path(__file__).parent.parent)
if result.returncode != 0:
print(f"Failed to push tag: {result.stderr}")
return False
return True
except Exception as e:
print(f"Error creating git tag: {e}")
return False
def save_changelog_file(version: str, changelog: str) -> None:
"""Save changelog to file."""
changelog_dir = Path(__file__).parent.parent / "docs" / "releases"
changelog_dir.mkdir(parents=True, exist_ok=True)
changelog_file = changelog_dir / f"v{version}.md"
with open(changelog_file, 'w') as f:
f.write(changelog)
# Update main changelog
main_changelog = Path(__file__).parent.parent / "CHANGELOG.md"
if main_changelog.exists():
with open(main_changelog, 'r') as f:
existing_content = f.read()
else:
existing_content = "# Felix Framework Changelog\n\n"
with open(main_changelog, 'w') as f:
f.write("# Felix Framework Changelog\n\n")
f.write(changelog)
f.write("\n---\n\n")
if "# Felix Framework Changelog" in existing_content:
# Remove the header from existing content
existing_content = existing_content.split("\n\n", 1)[1] if "\n\n" in existing_content else ""
f.write(existing_content)
def bump_version(version_type: str, release_type: str = None, release_name: str = None,
dry_run: bool = False) -> None:
"""Bump version and create release."""
print(f"π Felix Framework Version Bump ({version_type})")
# Load current version
current_version = load_version_file()
print(f"π Current version: {current_version['version']}")
# Parse version type
try:
bump_type = VersionType(version_type)
except ValueError:
print(f"β Invalid version type: {version_type}")
print(f"Valid types: {[t.value for t in VersionType]}")
sys.exit(1)
# Parse release type for prereleases
prerelease_type = None
if bump_type == VersionType.PRERELEASE and release_type:
try:
prerelease_type = ReleaseType(release_type)
except ValueError:
print(f"β Invalid release type: {release_type}")
print(f"Valid types: {[t.value for t in ReleaseType]}")
sys.exit(1)
# Increment version
new_version = increment_version(current_version, bump_type, prerelease_type)
new_version['release_name'] = release_name or f"Release {new_version['version']}"
print(f"π New version: {new_version['version']}")
print(f"π·οΈ Release name: {new_version['release_name']}")
# Generate changelog
changelog = generate_changelog(current_version, new_version)
if dry_run:
print(f"\nπ Changelog Preview:")
print(changelog)
print(f"\nβ οΈ Dry run - no changes made")
return
# Save new version
save_version_file(new_version)
print(f"β
Updated VERSION.json")
# Save changelog
save_changelog_file(new_version['version'], changelog)
print(f"β
Updated changelog files")
# Create git tag
if create_git_tag(new_version['version'], changelog):
print(f"β
Created git tag v{new_version['version']}")
else:
print(f"β Failed to create git tag")
print(f"\nπ Version bump completed: v{new_version['version']}")
print(f"π¦ Ready for deployment to HuggingFace Spaces")
def main():
"""Main CLI interface."""
if len(sys.argv) < 2:
print("Usage: python version_manager.py <major|minor|patch|prerelease> [release_type] [--release-name NAME] [--dry-run]")
print("\nExamples:")
print(" python version_manager.py patch")
print(" python version_manager.py minor --release-name 'ZeroGPU Integration'")
print(" python version_manager.py prerelease alpha --dry-run")
sys.exit(1)
version_type = sys.argv[1]
release_type = None
release_name = None
dry_run = False
# Parse arguments
args = sys.argv[2:]
i = 0
while i < len(args):
if args[i] == "--release-name" and i + 1 < len(args):
release_name = args[i + 1]
i += 2
elif args[i] == "--dry-run":
dry_run = True
i += 1
elif version_type == "prerelease" and release_type is None:
release_type = args[i]
i += 1
else:
i += 1
bump_version(version_type, release_type, release_name, dry_run)
if __name__ == "__main__":
main() |