Update documentation and fix repository URL
- Add package_extension.sh documentation to scripts README - Add Development section to main README with Joomla workflows - Fix repository URL typo (moko-cassiopeoa -> moko-cassiopeia) - Remove extra space in repository URL Co-authored-by: jmiller-moko <230051081+jmiller-moko@users.noreply.github.com>
This commit is contained in:
41
README.md
41
README.md
@@ -43,6 +43,7 @@ upgrade-friendly.
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [Dark Mode Toggle](#dark-mode-toggle)
|
||||
- [Soft Offline Mode](#soft-offline-mode)
|
||||
- [Development](#development)
|
||||
- [Changelog](#changelog)
|
||||
- [Roadmap](#roadmap)
|
||||
|
||||
@@ -129,6 +130,44 @@ If upgrading from a prior version, Joomla will safely overwrite files
|
||||
offline/maintenance mode.
|
||||
- Useful for compliance, legal, or policy content.
|
||||
|
||||
## Development
|
||||
|
||||
For developers and contributors working on the moko-cassiopeia template:
|
||||
|
||||
### Joomla Development Workflows
|
||||
|
||||
Comprehensive Joomla-aware development tools and workflows are available:
|
||||
|
||||
- **Extension Packaging** - Create distributable ZIP packages
|
||||
- **PHP Quality Checks** - PHPStan and PHP_CodeSniffer with Joomla standards
|
||||
- **Automated Testing** - Codeception framework with multiple Joomla versions
|
||||
- **CI/CD Pipelines** - GitHub Actions for testing and deployment
|
||||
|
||||
See the [Joomla Development Guide](./docs/JOOMLA_DEVELOPMENT.md) for:
|
||||
- Setup instructions for local development
|
||||
- Running tests and quality checks
|
||||
- Creating release packages
|
||||
- Deployment workflows
|
||||
- CI/CD pipeline details
|
||||
|
||||
### Quick Start for Developers
|
||||
|
||||
```bash
|
||||
# Validate code
|
||||
./scripts/validate/php_syntax.sh
|
||||
./scripts/validate/manifest.sh
|
||||
|
||||
# Create distribution package
|
||||
./scripts/release/package_extension.sh dist 3.5.0
|
||||
|
||||
# Run tests (requires Codeception)
|
||||
codecept run
|
||||
|
||||
# Check code quality (requires PHPStan/PHPCS)
|
||||
phpstan analyse --configuration=phpstan.neon
|
||||
phpcs --standard=phpcs.xml
|
||||
```
|
||||
|
||||
## Changelog
|
||||
|
||||
See the [CHANGELOG.md](./CHANGELOG.md) for detailed version history.
|
||||
@@ -138,7 +177,7 @@ See the [CHANGELOG.md](./CHANGELOG.md) for detailed version history.
|
||||
## Metadata
|
||||
|
||||
* Maintainer: Moko Consulting Engineering
|
||||
* Repository: [https: //github.com/mokoconsulting-tech/moko-cassiopeoa](https: //github.com/mokoconsulting-tech/moko-cassiopeoa)
|
||||
* Repository: [https://github.com/mokoconsulting-tech/moko-cassiopeia](https://github.com/mokoconsulting-tech/moko-cassiopeia)
|
||||
* File: README.md
|
||||
* Version: 3.0
|
||||
* Classification: Public Open Source Standards
|
||||
|
||||
@@ -211,6 +211,37 @@ Example:
|
||||
./scripts/release/update_dates.sh 2025-01-15 03.05.00
|
||||
```
|
||||
|
||||
### `package_extension.sh`
|
||||
Package the Joomla template as a distributable ZIP file.
|
||||
|
||||
Usage:
|
||||
```bash
|
||||
./scripts/release/package_extension.sh [output_dir] [version]
|
||||
```
|
||||
|
||||
Parameters:
|
||||
- `output_dir` (optional): Output directory for ZIP file (default: `dist`)
|
||||
- `version` (optional): Version string (default: extracted from manifest)
|
||||
|
||||
Examples:
|
||||
```bash
|
||||
# Package with defaults (dist directory, auto-detect version)
|
||||
./scripts/release/package_extension.sh
|
||||
|
||||
# Package to specific directory with version
|
||||
./scripts/release/package_extension.sh /tmp/packages 3.5.0
|
||||
|
||||
# Package to dist with specific version
|
||||
./scripts/release/package_extension.sh dist 3.5.0
|
||||
```
|
||||
|
||||
Features:
|
||||
- Automatically detects extension type from manifest
|
||||
- Excludes development files (node_modules, vendor, tests, etc.)
|
||||
- Validates manifest before packaging
|
||||
- Creates properly structured Joomla installation package
|
||||
- Outputs JSON status for automation
|
||||
|
||||
## Run Scripts (`run/`)
|
||||
|
||||
Execution and testing scripts.
|
||||
|
||||
Reference in New Issue
Block a user