From 271fef53bd19e23e39613c541562afd0f19375a4 Mon Sep 17 00:00:00 2001 From: Jonathan Miller Date: Thu, 23 Apr 2026 14:59:30 -0500 Subject: [PATCH] docs: update docs for MokoOnyx switch and cascade channels - Replace MokoCassiopeia references with MokoOnyx in testing guide - Add cascade release channels and sync-to-main documentation Co-Authored-By: Claude Opus 4.6 (1M context) --- docs/guides/testing-guide.md | 6 +++--- docs/update-server.md | 40 ++++++++++++++++++++++++++++-------- 2 files changed, 35 insertions(+), 11 deletions(-) diff --git a/docs/guides/testing-guide.md b/docs/guides/testing-guide.md index 11491f7..1646dee 100644 --- a/docs/guides/testing-guide.md +++ b/docs/guides/testing-guide.md @@ -41,7 +41,7 @@ | 4 | Check admin dashboard | "Welcome to MokoWaaS!" appears in control panel | [ ] | | 5 | Check admin footer | "Powered by MokoWaaS" appears | [ ] | | 6 | Check admin login page | "MokoWaaS Administrator Login" title, support links show "Moko Consulting" | [ ] | -| 7 | Check frontend footer | "Powered by MokoWaaS" in Cassiopeia template | [ ] | +| 7 | Check frontend footer | "Powered by MokoWaaS" in MokoOnyx template | [ ] | | 8 | Check Joomla override files at `administrator/language/overrides/en-GB.override.ini` | Contains `BEGIN MokoWaaS Overrides` sentinel block | [ ] | | 9 | Check Joomla override files at `language/overrides/en-GB.override.ini` | Contains `BEGIN MokoWaaS Overrides` sentinel block | [ ] | @@ -87,7 +87,7 @@ |---|------|-----------------|------| | 1 | Set Enable Branding to "No", save | Save succeeds | [ ] | | 2 | Reload admin dashboard | Default Joomla strings appear (e.g., "Welcome to Joomla!") | [ ] | -| 3 | Check frontend footer | Default "Powered by Joomla" or Cassiopeia default | [ ] | +| 3 | Check frontend footer | Default "Powered by Joomla" or MokoOnyx default | [ ] | | 4 | Set Enable Branding back to "Yes", save | Branding strings restored immediately | [ ] | ### 2.7 Update (Upgrade from Previous Version) @@ -138,7 +138,7 @@ Verify the following admin areas no longer show "Joomla": | # | Location | Expected Brand Text | Pass | |---|----------|-------------------|------| -| 1 | Cassiopeia footer | "Powered by {brand}" | [ ] | +| 1 | MokoOnyx footer | "Powered by {brand}" | [ ] | | 2 | Site offline page | Maintenance message (no Joomla reference) | [ ] | | 3 | 404 error page | "Page Not Found" (no Joomla reference) | [ ] | | 4 | Frontend login support | "{company} Support" / "{brand} Documentation" | [ ] | diff --git a/docs/update-server.md b/docs/update-server.md index a149658..5bfe032 100644 --- a/docs/update-server.md +++ b/docs/update-server.md @@ -29,8 +29,30 @@ Joomla checks for extension updates by fetching an XML file from the URL defined | Event | Workflow | `` | `` | |-------|----------|---------|-------------| | Merge to `main` | `auto-release.yml` | `stable` | `XX.YY.ZZ` | -| Push to `dev/**` | `deploy-dev.yml` | `development` | `development` | -| Push to `rc/**` | `deploy-dev.yml` | `rc` | `XX.YY.ZZ-rc` | +| Push to `dev` or `dev/**` | `update-server.yml` | `development` | `XX.YY.ZZ-dev` | +| Push to `alpha/**` | `update-server.yml` | `alpha` | `XX.YY.ZZ-alpha` | +| Push to `beta/**` | `update-server.yml` | `beta` | `XX.YY.ZZ-beta` | +| Push to `rc/**` | `update-server.yml` | `rc` | `XX.YY.ZZ-rc` | + +**Trigger behavior**: `update-server.yml` triggers on both direct pushes and PR merges to `dev`, `dev/**`, `alpha/**`, `beta/**`, and `rc/**` branches. It supports bare `dev` branches (not just `dev/**` patterns). + +### Cascade Release Channels + +Each stability level writes itself **and all lower channels** to `updates.xml`: + +| Release Stream | Channels written | +|---------------|-----------------| +| development | `development` | +| alpha | `development`, `alpha` | +| beta | `development`, `alpha`, `beta` | +| rc | `development`, `alpha`, `beta`, `rc` | +| stable | `development`, `alpha`, `beta`, `rc`, `stable` | + +This ensures Joomla sites on any "Minimum Stability" setting always see the latest available release. + +### Sync to Main + +Since Joomla sites read `updates.xml` from the `main` branch, the `update-server.yml` workflow **syncs `updates.xml` to `main` via the Gitea API** after building on non-main branches. This ensures pre-release channel entries are visible to sites checking for updates without requiring a PR merge to main. ### Generated XML Structure @@ -94,14 +116,16 @@ Your XML manifest must include an `` tag pointing to the `update. ### Branch Lifecycle ``` -dev/XX.YY.ZZ → rc/XX.YY.ZZ → main → version/XX.YY -(development) (rc) (stable) (frozen snapshot) +dev → [alpha] → [beta] → rc → version/XX → main → dev + optional optional (integration) (production) (feedback) ``` -1. **Development** (`dev/**`): `update.xml` with `development`, download points to branch archive -2. **Release Candidate** (`rc/**`): `update.xml` with `rc`, version set to `XX.YY.ZZ-rc` -3. **Stable Release** (merge to `main`): `update.xml` with `stable`, download points to GitHub Release asset -4. **Frozen Snapshot** (`version/XX.YY`): immutable, never force-pushed +1. **Development** (`dev` or `dev/**`): `updates.xml` with `development`, download points to Gitea release ZIP +2. **Alpha** (`alpha/**`): `updates.xml` with `alpha`, cascades to development channel +3. **Beta** (`beta/**`): `updates.xml` with `beta`, cascades to alpha + development channels +4. **Release Candidate** (`rc/**`): `updates.xml` with `rc`, cascades to beta + alpha + development channels +5. **Stable Release** (merge to `main`): `updates.xml` with `stable`, cascades to all channels, download points to GitHub Release asset +6. **Frozen Snapshot** (`version/XX`): immutable, never force-pushed ### Health Checks -- 2.52.0