Frappe Operator v2.0.0 Release Guide

Release Summary

Version: v2.0.0
Release Date: November 27, 2024
Release Title: Hybrid App Installation & Enterprise Features


🎯 Release Highlights

Major Features

  1. βœ… Hybrid App Installation - FPM, Git, and Image sources
  2. βœ… Enterprise Git Control - Disable Git cluster-wide
  3. βœ… FPM Repository Management - Private packages with authentication
  4. βœ… FrappeBench CRD - Formal bench management
  5. βœ… Comprehensive Documentation - Migration guides and examples
  6. βœ… Backward Compatibility - No breaking changes

Statistics

  • Files Created: 16
  • Files Modified: 9
  • Code Added: ~4,000 lines
  • Documentation: ~30 KB
  • Tests: βœ… Passed

πŸ“¦ Release Artifacts

Documentation

  • README.md updated with new features
  • RELEASE_NOTES.md created
  • CHANGELOG.md created
  • FPM_MIGRATION.md (migration guide)
  • HYBRID_FPM_IMPLEMENTATION.md (technical docs)
  • INSTALLATION.md
  • Examples created (13 files)

Code

  • API types updated
  • Controllers implemented
  • CRDs generated
  • Operator deployed and tested
  • All tests passing

🏷️ Git Tag Instructions

Step 1: Verify All Changes Are Committed

cd /Users/varkrish/personal/frappe-operator

# Check status
git status

# Review changes
git log --oneline -10

Step 2: Create Annotated Tag

# Create v2.0.0 tag with release notes
git tag -a v2.0.0 -m "Frappe Operator v2.0.0 - Hybrid App Installation & Enterprise Features

Major Features:
- Hybrid app installation (FPM, Git, Image sources)
- Enterprise Git control (disable Git cluster-wide)
- FPM repository management with authentication
- FrappeBench CRD with comprehensive configuration
- Complete documentation and migration guides

Full release notes: https://github.com/vyogotech/frappe-operator/blob/main/RELEASE_NOTES.md

Changelog: https://github.com/vyogotech/frappe-operator/blob/main/CHANGELOG.md"

Step 3: Verify Tag

# List tags
git tag -l

# Show tag details
git show v2.0.0

Step 4: Push Tag to Remote

# Push the tag
git push origin v2.0.0

# Verify on GitHub
# Navigate to: https://github.com/vyogotech/frappe-operator/releases

πŸ“ GitHub Release Instructions

Step 1: Navigate to GitHub Releases

  1. Go to: https://github.com/vyogotech/frappe-operator/releases
  2. Click β€œDraft a new release”

Step 2: Fill Release Information

Tag version: v2.0.0
Release title: v2.0.0 - Hybrid App Installation & Enterprise Features

Description: (Copy from RELEASE_NOTES.md)

# Frappe Operator v2.0.0

**Release Date:** November 27, 2024

## πŸŽ‰ Major Features

### Hybrid App Installation

Install Frappe apps from three different sources:

1. **FPM Packages** - Versioned packages from repositories
2. **Git Repositories** - Traditional bench get-app
3. **Pre-built Images** - Fastest startup

**Example:**

\`\`\`yaml
spec:
  apps:
    - name: frappe
      source: image
    - name: erpnext
      source: fpm
      org: frappe
      version: "15.0.0"
    - name: custom_app
      source: git
      gitUrl: https://github.com/company/custom_app.git
\`\`\`

### Enterprise Git Control

Disable Git access cluster-wide for security compliance.

### FPM Repository Management

Configure multiple FPM repositories with authentication.

## πŸ“¦ Installation

\`\`\`bash
kubectl apply -f https://raw.githubusercontent.com/vyogotech/frappe-operator/v2.0.0/install.yaml
\`\`\`

## πŸ“– Documentation

- [Complete Release Notes](RELEASE_NOTES.md)
- [Migration Guide](FPM_MIGRATION.md)
- [Technical Implementation](HYBRID_FPM_IMPLEMENTATION.md)
- [Changelog](CHANGELOG.md)

## 🎯 What's New

βœ… Hybrid app installation (FPM, Git, Image)  
βœ… Enterprise Git disable feature  
βœ… FPM repository management  
βœ… FrappeBench CRD  
βœ… Private package support  
βœ… Air-gapped deployments  
βœ… Complete documentation  

## πŸ”„ Upgrading

**No breaking changes!** Fully backward compatible.

See [FPM_MIGRATION.md](FPM_MIGRATION.md) for migration guide.

## πŸ™ Acknowledgments

Thank you to all contributors and users for making this release possible!

⭐ If you find this useful, please star the project!

Step 3: Attach Files (Optional)

  • install.yaml
  • install.sh
  • Release binaries (if applicable)

Step 4: Publish Release

  1. βœ… Check β€œSet as the latest release”
  2. βœ… Click β€œPublish release”

πŸš€ Post-Release Tasks

Immediate

  • Verify release is visible on GitHub
  • Test installation from release tag
  • Update project website (if applicable)
  • Announce on social media/forums

Communication

  • Post announcement on GitHub Discussions
  • Post on Frappe Forum (discuss.frappe.io)
  • Update documentation site
  • Send newsletter (if applicable)

Monitoring

  • Monitor GitHub issues for release-related bugs
  • Track download/usage statistics
  • Gather user feedback

πŸ“Š Release Checklist

Pre-Release

  • All tests passing
  • Documentation updated
  • Examples verified
  • CHANGELOG.md updated
  • RELEASE_NOTES.md created
  • Version bumped

Release

  • Git tag created
  • Tag pushed to GitHub
  • GitHub Release published
  • Release notes published

Post-Release

  • Installation verified
  • Announcements made
  • Issues monitored
  • Feedback collected

🎯 Version Information

Current Version: v2.0.0
Previous Version: v1.0.0
Next Planned: v2.1.0

Backward Compatibility: βœ… Yes
Breaking Changes: ❌ No
Migration Required: ❌ Optional


πŸ“ž Support

Get Help

  • Documentation: https://vyogotech.github.io/frappe-operator/
  • GitHub Issues: https://github.com/vyogotech/frappe-operator/issues
  • Discussions: https://github.com/vyogotech/frappe-operator/discussions

Report Issues

  • Bug Reports: https://github.com/vyogotech/frappe-operator/issues/new?template=bug_report.md
  • Feature Requests: https://github.com/vyogotech/frappe-operator/issues/new?template=feature_request.md

πŸŽ‰ Success Criteria

Release is successful when:

  • βœ… Git tag created and pushed
  • βœ… GitHub Release published
  • βœ… Installation instructions work
  • βœ… Documentation is accurate
  • βœ… No critical bugs reported
  • βœ… Community feedback is positive

πŸŽ‰ Ready to Release!

All documentation is complete, code is tested, and the operator is ready for v2.0.0!


Built with ❀️ by Vyogo Technologies

This site uses Just the Docs, a documentation theme for Jekyll.