MokoConsulting/MokoCassiopeia
1
1
Fork 0
Code Issues 2 Pull Requests Actions Packages Releases 1 Activity

Update WORKFLOW_GUIDE.md to reflect consolidated CI workflow

Browse Source 
Co-authored-by: jmiller-moko <230051081+jmiller-moko@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2026-01-09 01:46:04 +00:00
parent 723f74043e
commit ef57ec3ef4
1 changed files with 26 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
docs/WORKFLOW_GUIDE.md
View File

@@ -48,9 +48,11 @@ This repository uses GitHub Actions for continuous integration, testing, quality
**Trigger:** Automatic on push/PR to main, dev/*, rc/*, version/* branches
**Purpose:** Validates code quality and repository structure
**Purpose:** Comprehensive CI pipeline for validation, quality checks, and testing
**What it does:**
**Repository Validation:**
- ✅ Validates Joomla manifest XML
- ✅ Checks XML well-formedness
- ✅ Validates GitHub Actions workflows
@@ -59,6 +61,19 @@ This repository uses GitHub Actions for continuous integration, testing, quality
- ✅ Validates license headers
- ✅ Verifies version alignment
**PHP Code Quality:**
- 🔍 PHPStan static analysis (level 5)
- 📏 PHP_CodeSniffer with PSR-12 standards
- ✔️ PHP 8.0+ compatibility checks
- **Matrix:** PHP 8.0, 8.1, 8.2, 8.3
**Joomla Integration Testing:**
- 📦 Downloads and installs Joomla (4.4, 5.0, 5.1)
- 🔧 Installs template into Joomla
- ✅ Validates template installation
- 🧪 Runs Codeception tests
- **Matrix:** Joomla 4.4/5.0/5.1 × PHP 8.0/8.1/8.2/8.3
**When to check:** After every commit
**How to view results:**
@@ -66,53 +81,24 @@ This repository uses GitHub Actions for continuous integration, testing, quality
# Via GitHub CLI
gh run list --workflow=ci.yml --limit 5
gh run view <run-id> --log
# View specific job logs
gh run view <run-id> --log --job=<job-id>
```
### PHP Quality Checks (php_quality.yml)
**Trigger:** Automatic on push/PR to main, dev/*, rc/*, version/* branches
**Purpose:** Ensures PHP code quality and compatibility
**What it does:**
- 🔍 PHPStan static analysis (level 5)
- 📏 PHP_CodeSniffer with PSR-12 standards
- ✔️ PHP 8.0+ compatibility checks
**Matrix:** PHP 8.0, 8.1, 8.2, 8.3
**When to check:** Before committing PHP changes
**How to run locally:**
**How to run checks locally:**
```bash
# Install tools
# Repository validation
python3 scripts/validate/manifest.py
python3 scripts/validate/workflows.py
# PHP quality checks
composer global require "squizlabs/php_codesniffer:^3.0" --with-all-dependencies
composer global require "phpstan/phpstan:^1.0" --with-all-dependencies
# Run checks
phpcs --standard=phpcs.xml src/
phpstan analyse --configuration=phpstan.neon
```
### Joomla Testing (joomla_testing.yml)
**Trigger:** Automatic on push/PR to main, dev/*, rc/* branches
**Purpose:** Tests template compatibility with Joomla versions
**What it does:**
- 📦 Downloads and installs Joomla (4.4, 5.0, 5.1)
- 🔧 Installs template into Joomla
- ✅ Validates template installation
- 🧪 Runs Codeception tests
**Matrix:** Joomla 4.4/5.0/5.1 × PHP 8.0/8.1/8.2/8.3
**When to check:** Before releasing new versions
**How to test locally:**
```bash
# See docs/JOOMLA_DEVELOPMENT.md for local testing setup
# Joomla testing (see docs/JOOMLA_DEVELOPMENT.md)
codecept run
```