Simplify client fork workflow to colors only
- Created templates/gitignore-template for client forks - Updated scripts/create-client-fork.sh to only handle colors - Updated .github/workflows/create-client-fork.yml to match simplified workflow - Updated docs/CLIENT_FORK_WORKFLOW.md with colors-only approach - Updated templates/README.md to remove custom code fork references - Client forks now only track custom color files, not README or custom code Co-authored-by: jmiller-moko <230051081+jmiller-moko@users.noreply.github.com>
This commit is contained in:
@@ -7,7 +7,7 @@
|
||||
|
||||
# MokoCassiopeia Template Files
|
||||
|
||||
This directory contains template files for client customizations and custom code forks.
|
||||
This directory contains template files for client color customizations.
|
||||
|
||||
---
|
||||
|
||||
@@ -31,19 +31,15 @@ A comprehensive template for creating custom color schemes. This template includ
|
||||
|
||||
---
|
||||
|
||||
### Client Fork README Template
|
||||
### Client Fork .gitignore Template
|
||||
|
||||
**File**: `CLIENT_FORK_README_TEMPLATE.md`
|
||||
**File**: `gitignore-template`
|
||||
|
||||
A simplified README template for client-specific forks. Use this as a starting point for documenting your customizations.
|
||||
A .gitignore template for client forks that ensures custom color files are tracked in the fork repository while maintaining proper ignore rules for other files.
|
||||
|
||||
**Usage**:
|
||||
1. Copy this file to the root of your fork repository as `README.md`
|
||||
2. Replace `[CLIENT NAME]` with your client's name
|
||||
3. Fill in brand colors and contact information
|
||||
4. Add client-specific notes and configurations
|
||||
|
||||
**For Comprehensive Fork Setup**: See [CLIENT_FORK_README.md](../CLIENT_FORK_README.md) for the complete client fork guide.
|
||||
- Automatically applied when using the client fork creation workflow
|
||||
- Can be manually copied to `.gitignore` in client fork repositories
|
||||
|
||||
---
|
||||
|
||||
@@ -53,9 +49,9 @@ A simplified README template for client-specific forks. Use this as a starting p
|
||||
|
||||
If you're creating a custom fork of MokoCassiopeia for a specific client:
|
||||
|
||||
1. **Start with the full guide**: Read [CLIENT_FORK_README.md](../CLIENT_FORK_README.md)
|
||||
1. **Use the automated workflow**: See [CLIENT_FORK_WORKFLOW.md](../docs/CLIENT_FORK_WORKFLOW.md)
|
||||
2. **Set up custom colors**: Use `colors_custom.css` as your starting point
|
||||
3. **Document your fork**: Copy `CLIENT_FORK_README_TEMPLATE.md` to your fork
|
||||
3. **Test thoroughly**: Verify colors in both light and dark modes
|
||||
|
||||
### Custom Colors Only
|
||||
|
||||
@@ -70,12 +66,13 @@ If you just need custom colors without forking:
|
||||
## 📚 Additional Resources
|
||||
|
||||
- **[Main README](../README.md)** - MokoCassiopeia features and installation
|
||||
- **[Client Fork Guide](../CLIENT_FORK_README.md)** - Complete guide for client forks
|
||||
- **[Client Fork Workflow](../docs/CLIENT_FORK_WORKFLOW.md)** - Automated fork setup guide
|
||||
- **[CSS Variables Reference](../docs/CSS_VARIABLES.md)** - All available CSS variables
|
||||
- **[Development Guide](../docs/JOOMLA_DEVELOPMENT.md)** - Development workflows
|
||||
|
||||
---
|
||||
|
||||
**Template Directory**: `/templates/`
|
||||
**Version**: 03.06.03
|
||||
**Version**: 03.08.04
|
||||
**Scope**: Colors only
|
||||
**Maintained by**: Moko Consulting
|
||||
|
||||
106
templates/gitignore-template
Normal file
106
templates/gitignore-template
Normal file
@@ -0,0 +1,106 @@
|
||||
# MokoCassiopeia Client Fork .gitignore Template
|
||||
# This file is copied to client forks to ensure custom color files are tracked
|
||||
|
||||
# DO NOT ignore custom color files in client forks
|
||||
# These files should be tracked to preserve client-specific branding
|
||||
#
|
||||
# The files below are intentionally NOT ignored:
|
||||
# src/media/css/colors/light/colors_custom.css
|
||||
# src/media/css/colors/dark/colors_custom.css
|
||||
|
||||
# ============================================================
|
||||
# Environment and secrets
|
||||
# ============================================================
|
||||
.env
|
||||
.env.local
|
||||
.env.*.local
|
||||
*.local.php
|
||||
*.secret.php
|
||||
configuration.php
|
||||
configuration.*.php
|
||||
configuration.local.php
|
||||
conf/conf.php
|
||||
conf/conf*.php
|
||||
secrets/
|
||||
*.secrets.*
|
||||
|
||||
# ============================================================
|
||||
# Logs, dumps and databases
|
||||
# ============================================================
|
||||
*.db
|
||||
*.db-journal
|
||||
*.dump
|
||||
*.log
|
||||
*.pid
|
||||
*.seed
|
||||
*.sql
|
||||
*.sql.gz
|
||||
*.sqlite
|
||||
*.sqlite3
|
||||
|
||||
# ============================================================
|
||||
# OS / Editor / IDE cruft
|
||||
# ============================================================
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
desktop.ini
|
||||
Thumbs.db:encryptable
|
||||
ehthumbs.db
|
||||
ehthumbs_vista.db
|
||||
$RECYCLE.BIN/
|
||||
System Volume Information/
|
||||
*.lnk
|
||||
Icon?
|
||||
.idea/
|
||||
.settings/
|
||||
.vscode/*
|
||||
!.vscode/tasks.json
|
||||
!.vscode/settings.json.example
|
||||
!.vscode/extensions.json
|
||||
*.code-workspace
|
||||
|
||||
# ============================================================
|
||||
# Package manager and dependencies
|
||||
# ============================================================
|
||||
node_modules/
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
pnpm-debug.log*
|
||||
lerna-debug.log*
|
||||
*.tgz
|
||||
package-lock.json
|
||||
yarn.lock
|
||||
pnpm-lock.yaml
|
||||
vendor/
|
||||
|
||||
# ============================================================
|
||||
# Build artifacts and temporary files
|
||||
# ============================================================
|
||||
dist/
|
||||
build/
|
||||
.cache/
|
||||
*.tmp
|
||||
*.temp
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
.#*
|
||||
\#*#
|
||||
|
||||
# ============================================================
|
||||
# Test and coverage
|
||||
# ============================================================
|
||||
tests/_output/
|
||||
coverage/
|
||||
.nyc_output/
|
||||
phpunit.xml
|
||||
.phpunit.result.cache
|
||||
|
||||
# ============================================================
|
||||
# Joomla specific
|
||||
# ============================================================
|
||||
administrator/cache/
|
||||
cache/
|
||||
tmp/
|
||||
logs/
|
||||
Reference in New Issue
Block a user