Jonathan Miller
20fbcabe87
Remove references to deleted build-release.sh and minify.js. Document current CI-driven release process and remaining download-google-fonts.sh script. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
75 lines
1.8 KiB
Markdown
75 lines
1.8 KiB
Markdown
<!-- Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
|
|
|
|
SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
# FILE INFORMATION
|
|
DEFGROUP: Joomla.Template.Site
|
|
INGROUP: MokoCassiopeia.Documentation
|
|
REPO: https://github.com/mokoconsulting-tech/MokoCassiopeia
|
|
FILE: scripts/README.md
|
|
VERSION: 03.09.04
|
|
BRIEF: Documentation for utility scripts
|
|
-->
|
|
|
|
# Scripts — MokoCassiopeia
|
|
|
|
Utility scripts for managing the MokoCassiopeia Joomla template.
|
|
|
|
## Available Scripts
|
|
|
|
### download-google-fonts.sh
|
|
|
|
**Purpose**: Download Google Fonts for local hosting.
|
|
|
|
**Usage**:
|
|
```bash
|
|
./scripts/download-google-fonts.sh
|
|
```
|
|
|
|
Downloads font files and generates CSS `@font-face` declarations for local serving, avoiding external CDN dependencies.
|
|
|
|
---
|
|
|
|
## Build & Release
|
|
|
|
Builds and releases are handled entirely by GitHub Actions workflows. There are no local build scripts.
|
|
|
|
### auto-release.yml
|
|
|
|
**Triggers**: Push to `version/*` branches, manual dispatch.
|
|
|
|
**Process**:
|
|
1. Reads version from `templateDetails.xml`
|
|
2. Builds ZIP from `src/` contents
|
|
3. Computes SHA-256 checksum
|
|
4. Creates/updates GitHub Release with ZIP asset
|
|
5. Updates `update.xml` with download URL and checksum
|
|
|
|
### update-server.yml
|
|
|
|
**Triggers**: Release published, manual dispatch.
|
|
|
|
**Process**:
|
|
1. Updates `updates.xml` with version, download URL, and SHA-256
|
|
2. Commits changes to main
|
|
|
|
---
|
|
|
|
## Release Process
|
|
|
|
All releases are automated via CI. To release:
|
|
|
|
1. Bump version in `src/templateDetails.xml`
|
|
2. Merge to main
|
|
3. The workflow detects the version, builds the ZIP, and creates the release
|
|
|
|
**Only create releases when `src/` has changes.** Non-src changes (docs, workflows, scripts) are cleanup and do not require a release.
|
|
|
|
---
|
|
|
|
## License
|
|
|
|
All scripts are licensed under GPL-3.0-or-later.
|
|
|
|
Copyright (C) 2026 Moko Consulting
|