v 1.7.0
This commit is contained in:
@@ -1,5 +1,9 @@
|
||||
# Plugin Management Documentation
|
||||
|
||||
**Last Updated:** January 10, 2026
|
||||
**Version:** 1.7.0
|
||||
**Status:** Production
|
||||
|
||||
This section covers plugin distribution, management, and integration from the IGNY8 app perspective.
|
||||
|
||||
## Contents
|
||||
@@ -7,30 +11,119 @@ This section covers plugin distribution, management, and integration from the IG
|
||||
1. [WORDPRESS-INTEGRATION.md](WORDPRESS-INTEGRATION.md) - Complete guide for WordPress integration management
|
||||
2. [PLUGIN-UPDATE-WORKFLOW.md](PLUGIN-UPDATE-WORKFLOW.md) - How plugin updates work and post-update checklist
|
||||
|
||||
## Overview
|
||||
|
||||
The IGNY8 plugin distribution system provides a comprehensive infrastructure for managing, distributing, and updating plugins across multiple platforms (WordPress, Shopify, custom sites). The system includes automated versioning, security features, update mechanisms, and monitoring.
|
||||
|
||||
## Quick Reference
|
||||
|
||||
### API Endpoints (Production)
|
||||
|
||||
| Endpoint | Purpose |
|
||||
|----------|---------|
|
||||
| `https://api.igny8.com/api/plugins/igny8-wp-bridge/download/` | Download latest plugin ZIP |
|
||||
| `https://api.igny8.com/api/plugins/igny8-wp-bridge/check-update/` | Check for updates (called by WP plugin) |
|
||||
| `https://api.igny8.com/api/plugins/igny8-wp-bridge/info/` | Get plugin metadata |
|
||||
| Endpoint | Purpose | Method |
|
||||
|----------|---------|--------|
|
||||
| `https://api.igny8.com/api/plugins/igny8-wp-bridge/download/` | Download latest plugin ZIP | GET |
|
||||
| `https://api.igny8.com/api/plugins/igny8-wp-bridge/check-update/` | Check for updates (called by WP plugin) | POST |
|
||||
| `https://api.igny8.com/api/plugins/igny8-wp-bridge/info/` | Get plugin metadata | GET |
|
||||
| `https://api.igny8.com/api/plugins/igny8-wp-bridge/register/` | Register new installation | POST |
|
||||
| `https://api.igny8.com/api/plugins/igny8-wp-bridge/health-check/` | Plugin health check | POST |
|
||||
|
||||
### Key Directories
|
||||
|
||||
| Path | Purpose |
|
||||
|------|---------|
|
||||
| `/data/app/igny8/plugins/wordpress/source/` | Plugin source code |
|
||||
| `/data/app/igny8/plugins/wordpress/source/igny8-wp-bridge/` | WordPress plugin source code |
|
||||
| `/data/app/igny8/plugins/wordpress/dist/` | Distribution ZIP files |
|
||||
| `/data/app/igny8/plugins/shopify/` | Shopify integration (planned) |
|
||||
| `/data/app/igny8/plugins/custom-site/` | Custom site integration (planned) |
|
||||
| `/data/app/igny8/backend/igny8_core/plugins/` | Django plugin management app |
|
||||
|
||||
### Database Models
|
||||
|
||||
- `Plugin` - Plugin registry (name, slug, platform)
|
||||
- `PluginVersion` - Version tracking with file info
|
||||
- `PluginInstallation` - Track installations per site
|
||||
- `PluginDownload` - Download analytics
|
||||
- `Plugin` - Plugin registry (name, slug, platform, status)
|
||||
- `PluginVersion` - Version tracking with file info, checksums, changelog
|
||||
- `PluginInstallation` - Track installations per site with version info
|
||||
- `PluginDownload` - Download analytics and tracking
|
||||
|
||||
### Current Plugin Status
|
||||
|
||||
| Platform | Plugin Name | Current Version | Status |
|
||||
|----------|-------------|-----------------|--------|
|
||||
| WordPress | IGNY8 WP Bridge | 1.3.3 | Production |
|
||||
| Shopify | IGNY8 Shopify | - | Infrastructure Ready |
|
||||
| Custom | IGNY8 Bridge | - | Infrastructure Ready |
|
||||
|
||||
## System Features
|
||||
|
||||
### Distribution System
|
||||
- Automated ZIP package generation
|
||||
- Version-based file management
|
||||
- MD5 and SHA256 checksums
|
||||
- Signed download URLs
|
||||
- Rate limiting and security
|
||||
|
||||
### Update Mechanism
|
||||
- WordPress auto-update via `pre_set_site_transient_update_plugins` hook
|
||||
- Version comparison and update notifications
|
||||
- Changelog display
|
||||
- Compatibility checks
|
||||
|
||||
### Monitoring & Analytics
|
||||
- Installation tracking per site
|
||||
- Download counts and analytics
|
||||
- Health check endpoints
|
||||
- Version distribution tracking
|
||||
- Error logging and monitoring
|
||||
|
||||
### Security Features
|
||||
- Signed URLs with expiration
|
||||
- Checksum verification (MD5/SHA256)
|
||||
- Rate limiting per IP/site
|
||||
- API authentication for sensitive endpoints
|
||||
- Production environment protection
|
||||
|
||||
## Integration Flow
|
||||
|
||||
```
|
||||
Developer → Update Source Code → Create PluginVersion in Admin
|
||||
↓
|
||||
Automatic: Build ZIP, Calculate Checksums, Store in /dist/
|
||||
↓
|
||||
WordPress Site → Check for Updates → Download via API
|
||||
↓
|
||||
Install/Update → Register Installation → Health Check
|
||||
```
|
||||
|
||||
## Version Progression (Last 20 Commits)
|
||||
|
||||
**WordPress Plugin Versions:**
|
||||
- v1.3.3 - Template design improvements, image layout fixes
|
||||
- v1.3.2 - Template fixes in app and plugin
|
||||
- v1.3.1 - WordPress plugin updates
|
||||
- v1.3.0 - Initial distribution system release
|
||||
|
||||
**Infrastructure Updates:**
|
||||
- Plugin distribution system implemented (v1.7.0)
|
||||
- Database models for multi-platform support
|
||||
- API endpoints for lifecycle management
|
||||
- Automated packaging and versioning
|
||||
- Security and monitoring features
|
||||
|
||||
## Documentation Structure
|
||||
|
||||
### App-Side Documentation (This Folder)
|
||||
- Plugin distribution infrastructure
|
||||
- API endpoint documentation
|
||||
- Database models and admin interface
|
||||
- Integration workflows
|
||||
- Security and monitoring
|
||||
|
||||
### Plugin-Side Documentation
|
||||
See `/plugins/wordpress/source/igny8-wp-bridge/docs/` for:
|
||||
- Plugin PHP code and functions
|
||||
- WordPress hooks and filters
|
||||
- Template system
|
||||
- Content publishing flow
|
||||
- Plugin-specific configuration
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
# Plugin Update Workflow
|
||||
|
||||
**Last Updated:** January 9, 2026
|
||||
**Last Updated:** January 10, 2026
|
||||
**Version:** 1.7.0
|
||||
**Status:** Production
|
||||
**Scope:** How to release plugin updates and what happens automatically vs manually
|
||||
|
||||
@@ -10,7 +11,7 @@
|
||||
|
||||
The plugin release process has been **simplified** to require only 3 fields:
|
||||
|
||||
1. **Version** (e.g., 1.2.0)
|
||||
1. **Version** (e.g., 1.3.3)
|
||||
2. **Changelog** (what's new)
|
||||
3. **Status** (draft → released)
|
||||
|
||||
@@ -26,6 +27,27 @@ Django Admin → Add Plugin Version → Enter 3 fields → Save → Change statu
|
||||
|
||||
---
|
||||
|
||||
## Recent Release History (v1.7.0)
|
||||
|
||||
### WordPress Plugin Progression
|
||||
|
||||
| Version | Date | Type | Key Changes |
|
||||
|---------|------|------|-------------|
|
||||
| 1.3.3 | Jan 10, 2026 | Patch | Template design: Square image grid fixes, landscape image positioning, direct border-radius/shadow on images without captions |
|
||||
| 1.3.2 | Jan 9, 2026 | Patch | Template fixes in app and plugin, image layout improvements |
|
||||
| 1.3.1 | Jan 9, 2026 | Patch | WordPress plugin versioning updates |
|
||||
| 1.3.0 | Jan 8, 2026 | Minor | Initial distribution system release, automated updates |
|
||||
|
||||
### Distribution System Status
|
||||
|
||||
- ✅ Automated ZIP generation: Operational
|
||||
- ✅ Checksum calculation: MD5 + SHA256
|
||||
- ✅ WordPress auto-update: Active
|
||||
- ✅ Health checks: Implemented
|
||||
- ✅ Installation tracking: Complete
|
||||
|
||||
---
|
||||
|
||||
## Table of Contents
|
||||
|
||||
1. [Update Workflow Overview](#1-update-workflow-overview)
|
||||
@@ -36,6 +58,7 @@ Django Admin → Add Plugin Version → Enter 3 fields → Save → Change statu
|
||||
6. [Version Numbering](#6-version-numbering)
|
||||
7. [Rollback Procedure](#7-rollback-procedure)
|
||||
8. [Emergency Updates](#8-emergency-updates)
|
||||
9. [Recent Updates & Lessons Learned](#9-recent-updates--lessons-learned)
|
||||
|
||||
---
|
||||
|
||||
@@ -541,6 +564,78 @@ curl https://api.igny8.com/api/plugins/igny8-wp-bridge/check-update/?current_ver
|
||||
|
||||
---
|
||||
|
||||
## 9. Recent Updates & Lessons Learned
|
||||
|
||||
### v1.3.3 Release (Jan 10, 2026)
|
||||
|
||||
**Changes:**
|
||||
- Fixed square image grid layout (side-by-side display)
|
||||
- Fixed landscape image positioning in sections 4+
|
||||
- Removed card wrapper for images without captions
|
||||
- Applied border-radius/shadow directly to images
|
||||
- Landscape images now appear after first paragraph
|
||||
|
||||
**Process:**
|
||||
- Source code updated in plugin templates and CSS
|
||||
- Version bumped in `igny8-bridge.php` (header + constant)
|
||||
- Django admin: Created v1.3.3 with changelog
|
||||
- Status changed to "released" → ZIP auto-generated
|
||||
- Verified download endpoint and file contents
|
||||
- Template changes tested on staging WordPress site
|
||||
|
||||
**Lessons:**
|
||||
- CSS changes require thorough cross-browser testing
|
||||
- Image layout fixes need responsive design verification
|
||||
- Template changes should be tested with multiple content types
|
||||
|
||||
### v1.3.2 Release (Jan 9, 2026)
|
||||
|
||||
**Changes:**
|
||||
- Template rendering improvements
|
||||
- Image layout enhancements
|
||||
- Content section fixes
|
||||
|
||||
**Process:**
|
||||
- Standard release workflow
|
||||
- Auto-build successful
|
||||
- No rollback needed
|
||||
|
||||
### v1.3.0 Release (Jan 8, 2026)
|
||||
|
||||
**Changes:**
|
||||
- Initial distribution system implementation
|
||||
- WordPress auto-update mechanism
|
||||
- Base template system
|
||||
|
||||
**Process:**
|
||||
- Major release with new infrastructure
|
||||
- Extensive testing required
|
||||
- First use of automated packaging
|
||||
|
||||
### Distribution System Milestones
|
||||
|
||||
**v1.7.0 Infrastructure:**
|
||||
- ✅ Complete plugin distribution system
|
||||
- ✅ Multi-platform support architecture
|
||||
- ✅ Automated versioning and packaging
|
||||
- ✅ Security features (checksums, signed URLs)
|
||||
- ✅ Monitoring and analytics
|
||||
|
||||
**Best Practices Established:**
|
||||
1. Always test download endpoint after release
|
||||
2. Verify ZIP contents match source
|
||||
3. Check version number in extracted files
|
||||
4. Test update notification in WordPress
|
||||
5. Monitor download analytics
|
||||
|
||||
**Common Issues Resolved:**
|
||||
- ZIP generation timing → Now synchronous in signals
|
||||
- Checksum mismatches → Auto-calculated reliably
|
||||
- Version comparison → Semantic versioning logic fixed
|
||||
- File size tracking → Automatic and accurate
|
||||
|
||||
---
|
||||
|
||||
## Quick Reference Card
|
||||
|
||||
### Release New Version (Simplified)
|
||||
@@ -550,7 +645,7 @@ curl https://api.igny8.com/api/plugins/igny8-wp-bridge/check-update/?current_ver
|
||||
2. Update version in igny8-bridge.php (header + constant)
|
||||
3. Django Admin → Add Plugin Version:
|
||||
- Plugin: IGNY8 WordPress Bridge
|
||||
- Version: 1.2.0
|
||||
- Version: 1.3.3 (or next version)
|
||||
- Changelog: Describe changes
|
||||
- Status: draft
|
||||
- (All other fields auto-fill)
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
# WordPress Integration Management
|
||||
|
||||
**Last Updated:** January 9, 2026
|
||||
**Last Updated:** January 10, 2026
|
||||
**Version:** 1.7.0
|
||||
**Status:** Production
|
||||
**Scope:** App-side management of WordPress plugin distribution and site integrations
|
||||
|
||||
@@ -16,7 +17,8 @@
|
||||
6. [Django Admin Management](#6-django-admin-management)
|
||||
7. [Frontend Integration](#7-frontend-integration)
|
||||
8. [Site Integration Flow](#8-site-integration-flow)
|
||||
9. [Troubleshooting](#9-troubleshooting)
|
||||
9. [Recent Updates (v1.7.0)](#9-recent-updates-v170)
|
||||
10. [Troubleshooting](#10-troubleshooting)
|
||||
|
||||
---
|
||||
|
||||
@@ -31,6 +33,8 @@ This document covers the **app-side** management of WordPress integration:
|
||||
- API endpoints that WordPress plugins call
|
||||
- Admin interface for managing plugins and versions
|
||||
- Frontend components for plugin download
|
||||
- Plugin distribution infrastructure (v1.7.0)
|
||||
- Automated versioning and packaging system
|
||||
|
||||
### What This Document Does NOT Cover
|
||||
|
||||
@@ -38,6 +42,15 @@ This document covers the **app-side** management of WordPress integration:
|
||||
- WordPress-side setup and configuration
|
||||
- Plugin installation on WordPress sites
|
||||
|
||||
### Current Status (v1.7.0)
|
||||
|
||||
- ✅ WordPress Plugin: v1.3.3 (Production)
|
||||
- ✅ Distribution System: Fully operational
|
||||
- ✅ Auto-update Mechanism: Active
|
||||
- ✅ Template Design: Updated with image layout fixes
|
||||
- ✅ API Endpoints: All operational
|
||||
- ✅ Security Features: Checksums, signed URLs, rate limiting
|
||||
|
||||
---
|
||||
|
||||
## 2. Architecture
|
||||
@@ -594,6 +607,115 @@ unzip -p /data/app/igny8/plugins/wordpress/dist/igny8-wp-bridge-v1.1.1.zip \
|
||||
|
||||
| Log | Location |
|
||||
|-----|----------|
|
||||
| Django Logs | `/data/app/igny8/backend/logs/` |
|
||||
| Plugin API Logs | Check Django logs for `/api/plugins/` requests |
|
||||
| WordPress Plugin Logs | WP site's debug.log if WP_DEBUG enabled |
|
||||
|
||||
---
|
||||
|
||||
## 9. Recent Updates (v1.7.0)
|
||||
|
||||
### Plugin Distribution System Implemented
|
||||
|
||||
**Infrastructure:**
|
||||
- ✅ Complete plugin distribution system operational
|
||||
- ✅ Multi-platform support (WordPress, Shopify, Custom sites)
|
||||
- ✅ Automated ZIP packaging with versioning
|
||||
- ✅ Security features: checksums (MD5/SHA256), signed URLs, rate limiting
|
||||
- ✅ Monitoring and analytics dashboard
|
||||
|
||||
**Database Models:**
|
||||
- `Plugin` - Platform-agnostic plugin registry
|
||||
- `PluginVersion` - Full version lifecycle management
|
||||
- `PluginInstallation` - Per-site installation tracking
|
||||
- `PluginDownload` - Download analytics and monitoring
|
||||
|
||||
**API Endpoints:**
|
||||
- All 5 endpoints operational and tested
|
||||
- `/download/` - Serve plugin ZIP files
|
||||
- `/check-update/` - WordPress update mechanism
|
||||
- `/info/` - Plugin metadata
|
||||
- `/register/` - Installation registration
|
||||
- `/health-check/` - Plugin health monitoring
|
||||
|
||||
### WordPress Plugin Updates (v1.3.0 → v1.3.3)
|
||||
|
||||
**v1.3.3 - Template Design Improvements:**
|
||||
- Fixed square images displaying in 2 rows (now side-by-side)
|
||||
- Fixed landscape images in sections 4+ displaying incorrectly
|
||||
- Removed card wrapper for images without descriptions
|
||||
- Applied border-radius and shadow directly to images
|
||||
- Landscape images now appear after first paragraph
|
||||
- Consistent CSS classes for all image types
|
||||
|
||||
**v1.3.2 - Template Fixes:**
|
||||
- Template rendering improvements in app and plugin
|
||||
- Image layout enhancements
|
||||
- Content section fixes
|
||||
|
||||
**v1.3.1 - Plugin Updates:**
|
||||
- Versioning system improvements
|
||||
- WordPress plugin compatibility updates
|
||||
|
||||
**v1.3.0 - Initial Distribution System:**
|
||||
- First release with automated distribution
|
||||
- Update mechanism implementation
|
||||
- Base template system
|
||||
|
||||
### Version Progression Timeline
|
||||
|
||||
```
|
||||
v1.7.0 (Jan 10, 2026) - App infrastructure + plugin v1.3.3
|
||||
├── Plugin distribution system complete
|
||||
├── Template design overhaul
|
||||
├── Image layout fixes
|
||||
└── Pre-launch cleanup (Phases 1, 5, 6)
|
||||
|
||||
v1.6.2 (Jan 8, 2026) - Design refinements
|
||||
└── Marketing site updates
|
||||
|
||||
v1.6.0 (Jan 8, 2026) - Payment system refactor
|
||||
└── Stripe, PayPal, Bank Transfer
|
||||
|
||||
v1.4.0 (Jan 5, 2026) - AI model architecture overhaul
|
||||
└── IntegrationProvider, AIModelConfig
|
||||
```
|
||||
|
||||
### Infrastructure Improvements
|
||||
|
||||
**Security:**
|
||||
- Signed URLs with expiration for downloads
|
||||
- Checksum verification (MD5 + SHA256)
|
||||
- Rate limiting per IP/site
|
||||
- API authentication for sensitive operations
|
||||
- Production environment protection
|
||||
|
||||
**Automation:**
|
||||
- Auto-build on version status change
|
||||
- Automatic checksum calculation
|
||||
- File size tracking
|
||||
- Version number updates in ZIP contents
|
||||
- Released timestamp tracking
|
||||
|
||||
**Monitoring:**
|
||||
- Installation tracking per site
|
||||
- Download analytics
|
||||
- Health check endpoints
|
||||
- Version distribution monitoring
|
||||
- Error logging and alerts
|
||||
|
||||
### Documentation Updates
|
||||
|
||||
- Added comprehensive plugin distribution plan
|
||||
- Updated API endpoint documentation
|
||||
- Enhanced troubleshooting guides
|
||||
- Added version progression tracking
|
||||
- Updated architecture diagrams
|
||||
|
||||
---
|
||||
|
||||
## 10. Troubleshooting
|
||||
|-----|----------|
|
||||
| Django logs | `/data/app/logs/django.log` |
|
||||
| Plugin build logs | Check Django log for `"Created plugin ZIP"` messages |
|
||||
| Download tracking | `PluginDownload` model in database |
|
||||
|
||||
Reference in New Issue
Block a user