Public Access
Jonathan Miller
b73c1eba25
Generic: Repo Health / Scripts governance (push) Has been cancelled
Generic: Repo Health / Repository health (push) Has been cancelled
Generic: Repo Health / Report Issues (push) Has been cancelled
Generic: Project CI / Tests (pull_request) Has been cancelled
Platform: mokoplatform CI / Gate 2: Unit Tests (8.1) (pull_request) Has been cancelled
Platform: mokoplatform CI / Gate 2: Unit Tests (8.2) (pull_request) Has been cancelled
Platform: mokoplatform CI / Gate 2: Unit Tests (8.3) (pull_request) Has been cancelled
Platform: mokoplatform CI / Gate 3: Self-Health Check (pull_request) Has been cancelled
Platform: mokoplatform CI / Gate 4: Governance (pull_request) Has been cancelled
Platform: mokoplatform CI / Gate 5: Template Integrity (pull_request) Has been cancelled
Platform: mokoplatform CI / CI Summary (pull_request) Has been cancelled
Universal: PR Check / Build RC Package (pull_request) Has been cancelled
Universal: PR Check / Report Issues (pull_request) Has been cancelled
Generic: Repo Health / Scripts governance (pull_request) Has been cancelled
Generic: Repo Health / Repository health (pull_request) Has been cancelled
Generic: Repo Health / Report Issues (pull_request) Has been cancelled
Generic: Repo Health / Site Health (push) Has been cancelled
Generic: Repo Health / Access control (push) Has been cancelled
Generic: Repo Health / Site Health (pull_request) Has been cancelled
Universal: PR Check / Branch Policy (pull_request) Has been cancelled
Generic: Repo Health / Access control (pull_request) Has been cancelled
Universal: Build & Release / Promote to RC (pull_request) Has been cancelled
RC Revert / Rename rc/ back to dev/ (pull_request) Has been cancelled
Universal: Security Audit / Dependency Audit (pull_request) Has been cancelled
Branch Cleanup / Delete merged branch (pull_request) Has been cancelled
Universal: Secret Scanning / Gitleaks Secret Scan (pull_request) Has been cancelled
Universal: PR Check / Validate PR (pull_request) Has been cancelled
Universal: Build & Release / Build & Release Pipeline (pull_request) Has been cancelled
Generic: Project CI / Lint & Validate (pull_request) Has been cancelled
Platform: mokoplatform CI / Gate 1: Code Quality (pull_request) Has been cancelled
Scans source files to detect platform, name, version, element_name, package_type, language, entry_point, description, and license_spdx. Supports Joomla, Dolibarr, Go, MCP/Node, and generic platforms. Includes --diff and --update modes for comparing against and pushing to the Gitea manifest API. Warns on missing core fields. Also removes deprecated mcp/servers/mokowaas_api (consolidated to separate repo) and syncs dev branch changes.
104 lines
3.1 KiB
Markdown
104 lines
3.1 KiB
Markdown
<!--
|
|
Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
|
|
SPDX-License-Identifier: GPL-3.0-or-later
|
|
FILE INFORMATION
|
|
DEFGROUP: MokoPlatform.Index
|
|
INGROUP: MokoPlatform.Templates.Makefiles
|
|
REPO: https://git.mokoconsulting.tech/MokoConsulting/mokoplatform
|
|
PATH: /templates/makefiles/README.md
|
|
BRIEF: Makefile templates README
|
|
-->
|
|
|
|
# Makefile Templates
|
|
|
|
This directory contains Makefile templates for different repository types.
|
|
|
|
## Template Files
|
|
|
|
### Makefile.generic.template
|
|
Generic Makefile for standard repositories. Includes common targets for:
|
|
- Building and compiling
|
|
- Testing and linting
|
|
- Cleaning and maintenance
|
|
- Development workflow automation
|
|
|
|
**Usage:**
|
|
```bash
|
|
cp templates/makefiles/Makefile.generic.template ./Makefile
|
|
```
|
|
|
|
### Makefile.joomla.template
|
|
Joomla-specific Makefile for extensions (components, modules, plugins, etc.). Includes targets for:
|
|
- Joomla manifest validation
|
|
- Extension packaging
|
|
- Installation and deployment
|
|
- Testing with Joomla framework
|
|
- Build artifact creation
|
|
|
|
**Usage:**
|
|
```bash
|
|
cp templates/makefiles/Makefile.joomla.template ./Makefile
|
|
```
|
|
|
|
### Makefile.dolibarr.template
|
|
Dolibarr-specific Makefile for modules. Includes targets for:
|
|
- Module descriptor validation
|
|
- SQL migration management
|
|
- Module packaging
|
|
- Installation and deployment
|
|
- Testing with Dolibarr framework
|
|
- Build artifact creation
|
|
|
|
**Usage:**
|
|
```bash
|
|
cp templates/makefiles/Makefile.dolibarr.template ./Makefile
|
|
```
|
|
|
|
## Template Naming Convention
|
|
|
|
All Makefile templates use the `.template` extension to clearly distinguish them from active Makefile files. When copying to your repository:
|
|
|
|
1. **Remove the .template extension**: `Makefile.generic.template` → `Makefile`
|
|
2. **Customize for your project**: Update variables and targets as needed
|
|
3. **Test the targets**: Run `make help` to see available targets
|
|
|
|
## Customization
|
|
|
|
After copying a template:
|
|
|
|
1. Update project-specific variables at the top of the Makefile
|
|
2. Modify paths to match your repository structure
|
|
3. Add or remove targets based on your needs
|
|
4. Update dependencies between targets if necessary
|
|
|
|
## Schema Integration
|
|
|
|
These Makefile templates are referenced in the repository structure schemas:
|
|
|
|
- **default-repository.xml**: Uses `Makefile.generic.template` (suggested)
|
|
- **waas-component.xml**: Uses `Makefile.joomla.template` (required)
|
|
- **crm-module.xml**: Uses `Makefile.dolibarr.template` (required)
|
|
|
|
The schemas define source/destination mappings that automatically convert `.template` extensions to the final `Makefile` name.
|
|
|
|
## Common Targets
|
|
|
|
Most templates include these standard targets:
|
|
|
|
- `make help` - Display available targets
|
|
- `make build` - Build the project
|
|
- `make test` - Run tests
|
|
- `make lint` - Run linters
|
|
- `make clean` - Clean build artifacts
|
|
- `make install` - Install dependencies
|
|
- `make package` - Create distribution package
|
|
|
|
Platform-specific templates may include additional targets relevant to their ecosystem.
|
|
|
|
## Support
|
|
|
|
For questions or issues with Makefile templates:
|
|
- See main mokoplatform documentation
|
|
- Check the platform-specific guides (Joomla, Dolibarr)
|
|
- Review the schema documentation for source/destination details
|