PLugin versioning fixes
This commit is contained in:
@@ -6,6 +6,26 @@
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Quick Start: Simplified Release Process
|
||||
|
||||
The plugin release process has been **simplified** to require only 3 fields:
|
||||
|
||||
1. **Version** (e.g., 1.2.0)
|
||||
2. **Changelog** (what's new)
|
||||
3. **Status** (draft → released)
|
||||
|
||||
All other fields are either:
|
||||
- ✅ Auto-filled from previous version
|
||||
- ✅ Auto-generated on release (file path, size, checksum)
|
||||
- ✅ Auto-calculated (version code)
|
||||
|
||||
**Release in 3 clicks:**
|
||||
```
|
||||
Django Admin → Add Plugin Version → Enter 3 fields → Save → Change status to 'released'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Table of Contents
|
||||
|
||||
1. [Update Workflow Overview](#1-update-workflow-overview)
|
||||
@@ -128,11 +148,12 @@ WordPress will show "Update Available" in:
|
||||
| Action | When | How |
|
||||
|--------|------|-----|
|
||||
| **Update Source Version** | Before release | Edit `igny8-bridge.php` header |
|
||||
| **Create PluginVersion Record** | Each release | Django admin or management command |
|
||||
| **Write Changelog** | Each release | Enter in PluginVersion.changelog |
|
||||
| **Create PluginVersion Record** | Each release | Django admin: just enter version, changelog, status |
|
||||
| **Verify After Release** | After status change | Run verification checklist |
|
||||
| **Mark Old Version Deprecated** | After successful release | Change old version status |
|
||||
|
||||
**Note:** The form is simplified - most fields auto-fill from previous version or are auto-generated.
|
||||
|
||||
### Source Version Update Locations
|
||||
|
||||
When releasing a new version, update these in the source:
|
||||
@@ -154,6 +175,37 @@ define('IGNY8_BRIDGE_VERSION', '1.2.0'); ← AND THIS
|
||||
|
||||
## 4. Step-by-Step: Releasing a New Version
|
||||
|
||||
### The Simplified Process
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────────────────┐
|
||||
│ Simplified Version Release (3 Required Fields) │
|
||||
├─────────────────────────────────────────────────────────────────────────┤
|
||||
│ │
|
||||
│ Django Admin → Add Plugin Version │
|
||||
│ │
|
||||
│ ┌────────────────────────────────────────────────────────────────┐ │
|
||||
│ │ Plugin: [IGNY8 WordPress Bridge ▼] ← Select plugin │ │
|
||||
│ │ Version: [1.2.0] ← New version │ │
|
||||
│ │ Status: [draft ▼] ← Start as draft │ │
|
||||
│ │ Changelog: [Bug fixes and improvements] ← What's new │ │
|
||||
│ │ │ │
|
||||
│ │ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ │ │
|
||||
│ │ Everything below is AUTO-FILLED or AUTO-GENERATED: │ │
|
||||
│ │ │ │
|
||||
│ │ Min API Version: 1.0 (from previous version) │ │
|
||||
│ │ Min PHP Version: 7.4 (from previous version) │ │
|
||||
│ │ File Path: (empty) → Auto-generated on release │ │
|
||||
│ │ File Size: (empty) → Auto-calculated on release │ │
|
||||
│ │ Checksum: (empty) → Auto-calculated on release │ │
|
||||
│ │ Version Code: (empty) → Auto-calculated from version │ │
|
||||
│ └────────────────────────────────────────────────────────────────┘ │
|
||||
│ │
|
||||
│ Click [Save] → Status changes to 'released' → ZIP builds automatically │
|
||||
│ │
|
||||
└─────────────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### Step 1: Make Code Changes
|
||||
|
||||
```bash
|
||||
@@ -181,21 +233,35 @@ define('IGNY8_BRIDGE_VERSION', '1.2.0'); ← Match here
|
||||
1. Go to: `https://api.igny8.com/backend/`
|
||||
2. Navigate to: **Plugin Distribution** → **Plugin Versions**
|
||||
3. Click **Add Plugin Version**
|
||||
4. Fill in:
|
||||
4. Fill in **ONLY** these required fields:
|
||||
- **Plugin:** IGNY8 WordPress Bridge
|
||||
- **Version:** 1.2.0
|
||||
- **Status:** draft (initially)
|
||||
- **Changelog:** Describe changes
|
||||
- **Min PHP Version:** 7.4 (or higher if needed)
|
||||
5. Click **Save**
|
||||
|
||||
**Note:** All other fields are auto-filled:
|
||||
- `min_api_version`, `min_platform_version`, `min_php_version` → Copied from previous version
|
||||
- `file_path`, `file_size`, `checksum` → Auto-generated when you release
|
||||
- `version_code` → Auto-calculated from version number
|
||||
|
||||
### Step 4: Release the Version
|
||||
|
||||
**Option A: Release via Status Change**
|
||||
|
||||
1. Edit the PluginVersion you just created
|
||||
2. Change **Status** to `released`
|
||||
3. Click **Save**
|
||||
|
||||
**What happens:** Signal triggers auto-build → ZIP created → database updated
|
||||
**Option B: Release via Bulk Action**
|
||||
|
||||
1. Select the version(s) in the list
|
||||
2. Choose **Actions** → **✅ Release selected versions**
|
||||
3. Click **Go**
|
||||
|
||||
**What happens:** Signal triggers auto-build → ZIP created → database updated with file info
|
||||
|
||||
**Note:** You can also use the action **📢 Mark as update ready** to immediately notify WordPress sites.
|
||||
|
||||
### Step 5: Verify Release
|
||||
|
||||
@@ -211,32 +277,127 @@ Run the [verification checklist](#5-post-update-verification-checklist) below.
|
||||
|
||||
## 5. Post-Update Verification Checklist
|
||||
|
||||
### Immediate Checks (Do Every Release)
|
||||
### Quick Verification Script
|
||||
|
||||
Run this single command to verify everything:
|
||||
|
||||
```bash
|
||||
# 1. Verify ZIP exists
|
||||
ls -lh /data/app/igny8/plugins/wordpress/dist/igny8-wp-bridge-v1.2.0.zip
|
||||
#!/bin/bash
|
||||
# Complete Plugin Release Verification Script
|
||||
# Usage: Save as verify-plugin.sh and run: bash verify-plugin.sh 1.1.2
|
||||
|
||||
# 2. Verify symlink updated
|
||||
ls -la /data/app/igny8/plugins/wordpress/dist/igny8-wp-bridge-latest.zip
|
||||
VERSION=${1:-"latest"}
|
||||
PLUGIN_SLUG="igny8-wp-bridge"
|
||||
|
||||
echo "=========================================="
|
||||
echo "Plugin Release Verification: v${VERSION}"
|
||||
echo "=========================================="
|
||||
echo ""
|
||||
|
||||
# 1. Check ZIP file exists
|
||||
echo "1. Checking ZIP file..."
|
||||
if [ "$VERSION" = "latest" ]; then
|
||||
ls -lh /data/app/igny8/plugins/wordpress/dist/${PLUGIN_SLUG}-latest.zip 2>/dev/null && echo " ✓ Latest ZIP exists" || echo " ✗ Latest ZIP not found"
|
||||
else
|
||||
ls -lh /data/app/igny8/plugins/wordpress/dist/${PLUGIN_SLUG}-v${VERSION}.zip 2>/dev/null && echo " ✓ ZIP v${VERSION} exists" || echo " ✗ ZIP v${VERSION} not found"
|
||||
fi
|
||||
echo ""
|
||||
|
||||
# 2. Check symlink
|
||||
echo "2. Checking symlink..."
|
||||
ls -la /data/app/igny8/plugins/wordpress/dist/${PLUGIN_SLUG}-latest.zip | grep -q "^l" && echo " ✓ Symlink valid" || echo " ✗ Symlink missing"
|
||||
echo ""
|
||||
|
||||
# 3. Test download endpoint
|
||||
curl -s -o /dev/null -w "%{http_code} - %{size_download} bytes\n" \
|
||||
https://api.igny8.com/api/plugins/igny8-wp-bridge/download/
|
||||
echo "3. Testing download endpoint..."
|
||||
HTTP_CODE=$(curl -s -o /dev/null -w "%{http_code}" https://api.igny8.com/api/plugins/${PLUGIN_SLUG}/download/)
|
||||
FILE_SIZE=$(curl -s -o /dev/null -w "%{size_download}" https://api.igny8.com/api/plugins/${PLUGIN_SLUG}/download/)
|
||||
if [ "$HTTP_CODE" = "200" ]; then
|
||||
echo " ✓ Download works: ${HTTP_CODE} - ${FILE_SIZE} bytes ($(( FILE_SIZE / 1024 )) KB)"
|
||||
else
|
||||
echo " ✗ Download failed: HTTP ${HTTP_CODE}"
|
||||
fi
|
||||
echo ""
|
||||
|
||||
# 4. Test check-update endpoint
|
||||
curl -s "https://api.igny8.com/api/plugins/igny8-wp-bridge/check-update/?current_version=1.0.0" | python3 -m json.tool
|
||||
echo "4. Testing check-update endpoint..."
|
||||
UPDATE_RESPONSE=$(curl -s "https://api.igny8.com/api/plugins/${PLUGIN_SLUG}/check-update/?current_version=1.0.0")
|
||||
LATEST_VERSION=$(echo "$UPDATE_RESPONSE" | python3 -c "import sys, json; print(json.load(sys.stdin).get('latest_version', 'N/A'))" 2>/dev/null)
|
||||
if [ -n "$LATEST_VERSION" ] && [ "$LATEST_VERSION" != "N/A" ]; then
|
||||
echo " ✓ Check-update works: Latest version = $LATEST_VERSION"
|
||||
else
|
||||
echo " ✗ Check-update failed"
|
||||
fi
|
||||
echo ""
|
||||
|
||||
# 5. Test info endpoint
|
||||
curl -s https://api.igny8.com/api/plugins/igny8-wp-bridge/info/ | python3 -m json.tool
|
||||
echo "5. Testing info endpoint..."
|
||||
INFO_RESPONSE=$(curl -s "https://api.igny8.com/api/plugins/${PLUGIN_SLUG}/info/")
|
||||
PLUGIN_NAME=$(echo "$INFO_RESPONSE" | python3 -c "import sys, json; print(json.load(sys.stdin).get('name', 'N/A'))" 2>/dev/null)
|
||||
if [ -n "$PLUGIN_NAME" ] && [ "$PLUGIN_NAME" != "N/A" ]; then
|
||||
echo " ✓ Info endpoint works: $PLUGIN_NAME"
|
||||
else
|
||||
echo " ✗ Info endpoint failed"
|
||||
fi
|
||||
echo ""
|
||||
|
||||
# 6. Verify version in ZIP
|
||||
unzip -p /data/app/igny8/plugins/wordpress/dist/igny8-wp-bridge-v1.2.0.zip \
|
||||
igny8-wp-bridge/igny8-bridge.php | grep -E "Version:|IGNY8_BRIDGE_VERSION"
|
||||
echo "6. Verifying version in ZIP..."
|
||||
if [ "$VERSION" != "latest" ]; then
|
||||
ZIP_VERSION=$(unzip -p /data/app/igny8/plugins/wordpress/dist/${PLUGIN_SLUG}-v${VERSION}.zip ${PLUGIN_SLUG}/igny8-bridge.php 2>/dev/null | grep -E "Version:" | head -1 | awk '{print $3}')
|
||||
if [ "$ZIP_VERSION" = "$VERSION" ]; then
|
||||
echo " ✓ ZIP version matches: $ZIP_VERSION"
|
||||
else
|
||||
echo " ✗ ZIP version mismatch: expected $VERSION, got $ZIP_VERSION"
|
||||
fi
|
||||
else
|
||||
echo " - Skipped (use specific version to check)"
|
||||
fi
|
||||
echo ""
|
||||
|
||||
# 7. Verify API URL in ZIP (must be api.igny8.com)
|
||||
unzip -p /data/app/igny8/plugins/wordpress/dist/igny8-wp-bridge-v1.2.0.zip \
|
||||
igny8-wp-bridge/igny8-bridge.php | grep "api.igny8.com"
|
||||
# 7. Verify API URL
|
||||
echo "7. Verifying API URL in ZIP..."
|
||||
API_COUNT=$(unzip -p /data/app/igny8/plugins/wordpress/dist/${PLUGIN_SLUG}-latest.zip ${PLUGIN_SLUG}/igny8-bridge.php 2>/dev/null | grep -c "api.igny8.com")
|
||||
if [ "$API_COUNT" -gt 0 ]; then
|
||||
echo " ✓ API URL correct: api.igny8.com found (${API_COUNT} occurrences)"
|
||||
else
|
||||
echo " ✗ API URL incorrect: api.igny8.com not found"
|
||||
fi
|
||||
echo ""
|
||||
|
||||
# 8. Check database
|
||||
echo "8. Checking database..."
|
||||
docker exec igny8_backend python manage.py shell -c "
|
||||
from igny8_core.plugins.models import Plugin, PluginVersion
|
||||
try:
|
||||
p = Plugin.objects.get(slug='${PLUGIN_SLUG}')
|
||||
v = p.get_latest_version()
|
||||
if v:
|
||||
print(f' ✓ Latest version: {v.version}')
|
||||
print(f' ✓ Status: {v.status}')
|
||||
print(f' ✓ File: {v.file_path}')
|
||||
print(f' ✓ Size: {v.file_size:,} bytes ({v.file_size/1024:.1f} KB)')
|
||||
print(f' ✓ Checksum: {v.checksum[:32]}...')
|
||||
else:
|
||||
print(' ✗ No released version found')
|
||||
except Exception as e:
|
||||
print(f' ✗ Error: {e}')
|
||||
" 2>/dev/null | grep -E "✓|✗"
|
||||
echo ""
|
||||
|
||||
echo "=========================================="
|
||||
echo "Verification Complete"
|
||||
echo "=========================================="
|
||||
```
|
||||
|
||||
**Quick run (copy-paste):**
|
||||
|
||||
```bash
|
||||
# Verify latest version
|
||||
curl -s "https://api.igny8.com/api/plugins/igny8-wp-bridge/info/" | python3 -m json.tool && \
|
||||
curl -s "https://api.igny8.com/api/plugins/igny8-wp-bridge/check-update/?current_version=1.0.0" | python3 -m json.tool && \
|
||||
ls -lh /data/app/igny8/plugins/wordpress/dist/igny8-wp-bridge-latest.zip && \
|
||||
echo "✓ All endpoints working"
|
||||
```
|
||||
|
||||
### Database Verification
|
||||
@@ -382,17 +543,27 @@ curl https://api.igny8.com/api/plugins/igny8-wp-bridge/check-update/?current_ver
|
||||
|
||||
## Quick Reference Card
|
||||
|
||||
### Release New Version
|
||||
### Release New Version (Simplified)
|
||||
|
||||
```
|
||||
1. Edit source code
|
||||
1. Edit source code in /plugins/wordpress/source/igny8-wp-bridge/
|
||||
2. Update version in igny8-bridge.php (header + constant)
|
||||
3. Create PluginVersion in Django admin (status: draft)
|
||||
4. Change status to "released" → Auto-build triggers
|
||||
3. Django Admin → Add Plugin Version:
|
||||
- Plugin: IGNY8 WordPress Bridge
|
||||
- Version: 1.2.0
|
||||
- Changelog: Describe changes
|
||||
- Status: draft
|
||||
- (All other fields auto-fill)
|
||||
4. Change status to "released" (or use bulk action) → Auto-build triggers
|
||||
5. Run verification checklist
|
||||
6. Deprecate old version
|
||||
6. Optionally: Mark old version as deprecated
|
||||
```
|
||||
|
||||
**Admin Bulk Actions:**
|
||||
- **✅ Release selected versions** - Builds ZIP and marks as released
|
||||
- **📢 Mark as update ready** - Notifies WordPress sites
|
||||
- **🗑️ Mark as deprecated** - Deprecates old versions
|
||||
|
||||
### Verification Commands
|
||||
|
||||
```bash
|
||||
|
||||
@@ -390,23 +390,32 @@ View and manage plugin registry.
|
||||
|
||||
Manage versions and trigger releases.
|
||||
|
||||
| Field | Description |
|
||||
|-------|-------------|
|
||||
| Plugin | Parent plugin |
|
||||
| Version | Semantic version (e.g., 1.1.1) |
|
||||
| Status | draft, testing, staged, released, update_ready, deprecated |
|
||||
| File Path | Auto-set on release |
|
||||
| File Size | Auto-calculated on release |
|
||||
| Checksum | Auto-calculated on release |
|
||||
| Changelog | What's new (shown to users) |
|
||||
| Force Update | Set true for critical security fixes |
|
||||
**Required Fields Only:**
|
||||
- Plugin
|
||||
- Version (e.g., 1.2.0)
|
||||
- Changelog
|
||||
- Status
|
||||
|
||||
**Auto-Filled Fields:**
|
||||
- Min API/Platform/PHP versions (copied from previous version)
|
||||
- File path, size, checksum (generated on release)
|
||||
- Version code (calculated from version number)
|
||||
|
||||
**To Release a New Version:**
|
||||
|
||||
1. Create new PluginVersion record with status `draft`
|
||||
2. Enter version number, changelog
|
||||
3. Change status to `released` or `update_ready`
|
||||
4. Save → ZIP is automatically built
|
||||
1. Click **Add Plugin Version**
|
||||
2. Select plugin
|
||||
3. Enter version number (e.g., 1.2.0)
|
||||
4. Write changelog
|
||||
5. Set status to `draft`
|
||||
6. Save
|
||||
7. Change status to `released` (or use bulk action "✅ Release selected versions")
|
||||
8. ZIP is automatically built with all file info populated
|
||||
|
||||
**Bulk Actions:**
|
||||
- **✅ Release selected versions** - Builds ZIP and releases
|
||||
- **📢 Mark as update ready** - Notifies WordPress sites
|
||||
- **🗑️ Mark as deprecated** - Deprecates old versions
|
||||
|
||||
#### Plugin Installations
|
||||
|
||||
|
||||
Reference in New Issue
Block a user