Release Management

Release Management Skill

Reusable workflow extracted from app-release-manager expertise.

Purpose

Execute comprehensive pre-release quality assurance through automated checks, security audits, versioning, and professional release preparation to ensure production-ready software with zero tolerance for quality issues.

When to Use

• Pre-release quality validation
• Version release preparation
• Production deployment readiness assessment
• Post-development quality gates
• Continuous deployment pipeline final stage
• Major version releases
• Hotfix validation before deployment

Workflow Steps

1. Pre-Flight Checks
2. Verify git working tree is clean
3. Confirm on correct branch (main/master)
4. Check all changes are committed
5. Validate no merge conflicts
6. Ensure CI/CD pipeline is green

1. Model/Dependency Freshness (Phase 0 - Run First)
2. Search for latest model versions (AI models, dependencies)
3. Compare current configuration vs latest available
4. Auto-update configuration files if outdated
5. Rebuild project after updates
6. Verify models load correctly

1. Compilation & Build Quality (Phase 1)
2. Compile with warnings-as-errors enabled
3. Zero compiler warnings tolerance
4. Check for deprecated API usage
5. Validate build artifacts produced
6. Verify binary/bundle sizes within limits

1. Security Audit (Phase 2)
2. Scan for hardcoded secrets/credentials
3. Check for unsafe functions (strcpy, sprintf, etc.)
4. Static analysis with security rules
5. Dependency vulnerability scanning
6. Check for exposed sensitive files (.env, credentials)

1. Code Quality Gates (Phase 3)
2. Remove all TO-DO/FIX-ME comments
3. Remove debug prints (printf, NSLog, console.log)
4. Remove commented-out code
5. Check for trailing whitespace
6. Validate consistent code formatting
7. Remove unused imports/variables

1. Test Execution (Phase 4)
2. Run full unit test suite (100% pass required)
3. Execute integration tests
4. Run end-to-end (E2E) tests
5. Perform smoke tests
6. Execute regression test suite
7. Zero test failures tolerance

1. Documentation Validation (Phase 5)
2. Verify README is current and complete
3. Check API documentation up-to-date
4. Validate inline code comments
5. Ensure CHANGELOG updated
6. Verify installation instructions work

1. Version Management (Phase 6)
2. Update version number (SemVer: MAJOR.MINOR.PATCH)
3. Update VERSION file
4. Sync versions across package.json, setup.py, etc.
5. Generate/update CHANGELOG
6. Tag git commit with version

1. Auto-Fix Execution (Phase 7)
2. Automatically fix all auto-fixable issues
3. Remove trailing whitespace
4. Add missing EOF newlines
5. Remove debug prints
6. Remove unused imports
7. Re-run affected checks after fixes

1. Final Decision (Phase 8)
2. Aggregate all check results
3. Generate comprehensive release report
4. APPROVE (all checks pass) or BLOCK (any failures)
5. If BLOCKED: Provide prioritized fix list
6. If APPROVED: Proceed to release steps

1. Release Execution (Phase 9 - Only if Approved)
2. Create git tag for version
3. Push to remote repository
4. Create GitHub release with changelog
5. Build and publish artifacts (npm, PyPI, Docker, etc.)
6. Deploy to production (if auto-deploy enabled)
7. Notify stakeholders

Inputs Required

• Repository: Clean git working tree, committed changes
• Version: Target version number (or auto-increment)
• Release Type: major/minor/patch (for SemVer)
• Changelog: Summary of changes since last release
• Deployment target: Staging, production, or both

Outputs Produced

• Release Report: Comprehensive checklist with pass/fail status
• Auto-Fix Log: List of issues automatically fixed
• Blocking Issues: Prioritized list of issues preventing release
• Version Tag: Git tag with version number
• Release Artifacts: Built binaries, packages, containers
• CHANGELOG: Updated with version and changes
• GitHub Release: Published release with notes

Zero Tolerance Policy

Blocking Issues (NO RELEASE)

• ❌ ANY compiler warning
• ❌ ANY test failure
• ❌ ANY security vulnerability
• ❌ ANY TO-DO/FIX-ME in code
• ❌ ANY hardcoded secrets/credentials
• ❌ ANY debug prints in code
• ❌ ANY commented-out code
• ❌ ANY outdated dependencies with known CVEs
• ❌ ANY version mismatches across files
• ❌ ANY missing documentation for public APIs

Auto-Fix Protocol

Immediately Auto-Fixable Issues

| Issue | Auto-Fix Action | Priority | |-------|----------------|----------| | Compiler warnings | Edit source to fix | P0 | | TO-DO/FIX-ME comments | Remove or create ticket | P0 | | Debug prints | Remove all printf/console.log | P0 | | Version mismatches | Update VERSION file | P0 | | Trailing whitespace | sed strip command | P1 | | Missing EOF newline | echo >> file | P1 | | Unused imports | Remove automatically | P1 | | Outdated models | Update config, rebuild | P0 |

Auto-Fix Execution Pattern

FOR EACH issue found:
  IF auto-fixable:
    1. FIX IT IMMEDIATELY (use Edit/Write tools)
    2. VERIFY fix worked
    3. LOG: "Auto-fixed: {description}"
  ELSE:
    1. ADD to blocking issues list
    2. CONTINUE checking

AFTER all auto-fixes:
  RE-RUN affected checks
  IF issues remain: BLOCK release
  ELSE: APPROVE release

SemVer Version Bumping

Semantic Versioning (MAJOR.MINOR.PATCH)

• MAJOR: Breaking changes, incompatible API changes
• MINOR: New features, backward-compatible additions
• PATCH: Bug fixes, backward-compatible fixes

Version Increment Rules

Current: 1.4.2

Bump major (breaking): 2.0.0
Bump minor (feature):  1.5.0
Bump patch (bugfix):   1.4.3

Changelog Format (Keep a Changelog)

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/),
and this project adheres to [Semantic Versioning](https://semver.org/).

## [Unreleased]

## [1.5.0] - 2025-01-15

### Added
- New user authentication system with OAuth2
- Real-time notifications via WebSockets
- Export data to CSV feature

### Changed
- Improved API response time by 60% through caching
- Updated UI to Material Design 3

### Fixed
- Fixed memory leak in background worker
- Resolved race condition in payment processing

### Security
- Patched SQL injection vulnerability in search
- Updated dependencies to address CVE-2024-12345

## [1.4.2] - 2025-01-01

### Fixed
- Critical bug in user session management

Release Report Template

# Release Report: v{VERSION}

## Status: ✅ APPROVED / 🔴 BLOCKED

## Summary
- Total Checks: {count}
- Passed: {count}
- Failed: {count}
- Auto-Fixed: {count}

## Phase Results

### ✅ Phase 0: Model Freshness
- Models checked: {count}
- Models updated: {count}
- Status: UP_TO_DATE

### ✅ Phase 1: Compilation & Build
- Compiler warnings: 0
- Build succeeded: Yes
- Binary size: {size}MB

### ✅ Phase 2: Security Audit
- Hardcoded secrets: None found
- Unsafe functions: None found
- Dependency vulnerabilities: 0

### ✅ Phase 3: Code Quality
- TO-DO/FIX-ME: 0 (auto-fixed: {count})
- Debug prints: 0 (auto-fixed: {count})
- Commented code: None

### ✅ Phase 4: Tests
- Unit tests: {passed}/{total} (100%)
- Integration tests: {passed}/{total} (100%)
- E2E tests: {passed}/{total} (100%)

### ✅ Phase 5: Documentation
- README: Up-to-date
- API docs: Complete
- CHANGELOG: Updated

### ✅ Phase 6: Version Management
- Version: {version}
- SemVer: Valid
- Git tag: Created

## Auto-Fixes Applied
1. Removed 3 TO-DO comments
2. Stripped trailing whitespace (12 files)
3. Removed 5 debug print statements
4. Updated outdated model config

## Next Steps
1. Create GitHub release
2. Publish to npm/PyPI
3. Deploy to production
4. Notify stakeholders

Example Usage

Input: Prepare release f