Remove obsolete migration and workflow planning documentation

Co-authored-by: jmiller-moko <230051081+jmiller-moko@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2026-01-09 02:28:55 +00:00
parent e301e25b8f
commit ea53cd0cdd
4 changed files with 0 additions and 4349 deletions

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -1,251 +0,0 @@
# MokoStandards Migration Guide
## Current Status
**Updated:** 2026-01-09 - Migration to MokoStandards strategy **executed**
The workflows have been converted to thin caller workflows that reference reusable workflows in MokoStandards:
- `.github/workflows/ci.yml` (25 lines) - Calls `reusable-ci-validation.yml`
- `.github/workflows/php_quality.yml` (28 lines) - Calls `reusable-php-quality.yml`
- `.github/workflows/joomla_testing.yml` (25 lines) - Calls `reusable-joomla-testing.yml`
**Total:** 78 lines (down from 526 lines) - **85% reduction**
**Status:** ⚠️ Workflows reference MokoStandards reusable workflows at `@v1`. These reusable workflows need to be created in the MokoStandards repository for the workflows to function.
## Why Revert the Consolidation?
The initial consolidation approach created a **monolithic** `ci.yml` file (492 lines) that combined all three workflows. While this reduced file count, it went **against the documented MokoStandards strategy** which advocates for:
1. **Reusable workflows** in centralized repositories (MokoStandards/github-private)
2. **Thin caller workflows** in project repositories
3. **Organization-wide reusability** and standardization
## MokoStandards Architecture
### Repository Structure
**MokoStandards** (Public - https://github.com/mokoconsulting-tech/MokoStandards)
- Purpose: Public, shareable workflows and standards
- Location: `mokoconsulting-tech/MokoStandards`
- Status: **Repository exists but reusable workflows not yet created**
**.github-private** (Private)
- Purpose: Sensitive, proprietary workflows
- Location: `mokoconsulting-tech/.github-private`
- Status: Not verified in this migration
## Migration Steps
### Phase 1: Create Reusable Workflows in MokoStandards ⚠️ TODO
The following reusable workflows need to be created in the MokoStandards repository:
#### 1. `reusable-php-quality.yml`
Location: `MokoStandards/.github/workflows/reusable-php-quality.yml`
Should consolidate:
- PHP_CodeSniffer checks (PHPCS)
- PHPStan static analysis
- PHP Compatibility checks
Input parameters:
- `php-versions`: JSON array of PHP versions (default: `["8.0", "8.1", "8.2", "8.3"]`)
- `php-extensions`: Extensions to install (default: `"mbstring, xml, ctype, json, zip"`)
- `working-directory`: Working directory (default: `"."`)
- `phpstan-level`: PHPStan level (default: `"5"`)
See `docs/REUSABLE_WORKFLOWS.md` lines 177-250 for template.
#### 2. `reusable-joomla-testing.yml`
Location: `MokoStandards/.github/workflows/reusable-joomla-testing.yml`
Should consolidate:
- Joomla installation matrix
- Template installation
- Codeception test framework
Input parameters:
- `php-versions`: JSON array of PHP versions
- `joomla-versions`: JSON array of Joomla versions (default: `["4.4", "5.0", "5.1"]`)
- `template-path`: Path to template files (default: `"src"`)
#### 3. `reusable-ci-validation.yml`
Location: `MokoStandards/.github/workflows/reusable-ci-validation.yml`
Should consolidate:
- Manifest validation
- XML well-formedness checks
- Workflow validation
- Python validation scripts
Input parameters:
- `validation-scripts-path`: Path to validation scripts (default: `"scripts/validate"`)
### Phase 2: Update Project Workflows to Call Reusable Workflows ✅ COMPLETE
The project workflows have been updated to thin caller workflows:
#### Updated `php_quality.yml` ✅
Current implementation:
```yaml
name: PHP Code Quality
on:
push:
branches:
- main
- dev/**
- rc/**
- version/**
pull_request:
branches:
- main
- dev/**
- rc/**
- version/**
permissions:
contents: read
jobs:
quality:
uses: mokoconsulting-tech/MokoStandards/.github/workflows/reusable-php-quality.yml@v1
with:
php-versions: '["8.0", "8.1", "8.2", "8.3"]'
php-extensions: 'mbstring, xml, ctype, json, zip'
working-directory: '.'
phpstan-level: '5'
secrets: inherit
```
**Result:** 28 lines (down from 174 lines) - **84% reduction**
#### Updated `joomla_testing.yml` ✅
Current implementation:
```yaml
name: Joomla Testing
on:
push:
branches:
- main
- dev/**
- rc/**
pull_request:
branches:
- main
- dev/**
- rc/**
permissions:
contents: read
jobs:
testing:
uses: mokoconsulting-tech/MokoStandards/.github/workflows/reusable-joomla-testing.yml@v1
with:
php-versions: '["8.0", "8.1", "8.2", "8.3"]'
joomla-versions: '["4.4", "5.0", "5.1"]'
template-path: 'src'
secrets: inherit
```
**Result:** 25 lines (down from 270 lines) - **91% reduction**
#### Updated `ci.yml` ✅
Current implementation:
```yaml
name: Continuous Integration
on:
push:
branches:
- main
- dev/**
- rc/**
- version/**
pull_request:
branches:
- main
- dev/**
- rc/**
- version/**
permissions:
contents: read
jobs:
validation:
uses: mokoconsulting-tech/MokoStandards/.github/workflows/reusable-ci-validation.yml@v1
with:
validation-scripts-path: 'scripts/validate'
secrets: inherit
```
**Result:** 25 lines (down from 82 lines) - **70% reduction**
### Phase 3: Benefits After Migration ✅ ACHIEVED
**Before (Current State):**
- 3 workflow files: 526 total lines
- Duplicated logic across projects
- Maintenance burden on each project
- Inconsistent standards
**After (MokoStandards Strategy - CURRENT):**
- 3 caller files: 78 total lines (**85% reduction**) ✅
- Ready for shared, reusable workflows
- Centralized maintenance (once reusable workflows created)
- Consistent organization-wide standards
- Easy to propagate improvements
## Action Items
### For MokoStandards Repository Maintainers
- [ ] Create `reusable-php-quality.yml` in MokoStandards
- [ ] Create `reusable-joomla-testing.yml` in MokoStandards
- [ ] Create `reusable-ci-validation.yml` in MokoStandards
- [ ] Tag release (e.g., `v1.0.0`) for version stability
- [ ] Document usage in MokoStandards README
### For moko-cassiopeia Project ✅ COMPLETE
- [x] ~~Wait for reusable workflows to be available in MokoStandards~~
- [x] Update `php_quality.yml` to call reusable workflow (28 lines, 84% reduction)
- [x] Update `joomla_testing.yml` to call reusable workflow (25 lines, 91% reduction)
- [x] Update `ci.yml` to call reusable workflow (25 lines, 70% reduction)
- [ ] Test all workflows work correctly (requires MokoStandards reusable workflows)
- [x] Update migration guide to reflect completed status
## References
- **Current Project Workflows:** `.github/workflows/`
- **MokoStandards Repository:** https://github.com/mokoconsulting-tech/MokoStandards
- **Reusable Workflow Templates:** `docs/REUSABLE_WORKFLOWS.md`
- **Migration Plan:** `docs/CI_MIGRATION_PLAN.md`
- **Migration Checklist:** `docs/MIGRATION_CHECKLIST.md`
## Timeline
**Phase 1 (Pending):** Create reusable workflows in MokoStandards repository ⚠️
**Phase 2 (Complete):** Update project workflows to thin callers ✅ (2026-01-09)
**Current State:** Workflows converted to MokoStandards architecture. Waiting for reusable workflows to be created in MokoStandards repository.
**Next Action:** Create the three reusable workflows in MokoStandards to enable the caller workflows.
---
**Note:** This migration aligns with the documented strategy in `CI_MIGRATION_PLAN.md` and represents the proper implementation of the MokoStandards architecture.

File diff suppressed because it is too large Load Diff