Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 082c01fc46 |
@@ -1,68 +1,66 @@
|
|||||||
# Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
|
# Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
|
||||||
#
|
#
|
||||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
#
|
#
|
||||||
# FILE INFORMATION
|
# FILE INFORMATION
|
||||||
# DEFGROUP: Gitea.Workflow
|
# DEFGROUP: Gitea.Workflow
|
||||||
# INGROUP: moko-platform.Release
|
# INGROUP: moko-platform.Release
|
||||||
# REPO: https://git.mokoconsulting.tech/MokoConsulting/moko-platform
|
# REPO: https://git.mokoconsulting.tech/MokoConsulting/moko-platform
|
||||||
# PATH: /.mokogitea/workflows/auto-bump.yml
|
# PATH: /.mokogitea/workflows/auto-bump.yml
|
||||||
# VERSION: 09.23.00
|
# VERSION: 09.23.00
|
||||||
# BRIEF: Auto patch-bump version on every push to dev (skips merge commits)
|
# BRIEF: Auto patch-bump version on every push to dev (skips merge commits)
|
||||||
|
|
||||||
name: "Universal: Auto Version Bump"
|
name: "Universal: Auto Version Bump"
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- dev
|
- dev
|
||||||
- rc
|
- rc
|
||||||
- 'feature/**'
|
- 'feature/**'
|
||||||
- 'patch/**'
|
- 'patch/**'
|
||||||
|
|
||||||
env:
|
env:
|
||||||
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
|
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
|
||||||
GITEA_URL: ${{ vars.GITEA_URL || 'https://git.mokoconsulting.tech' }}
|
GITEA_URL: ${{ vars.GITEA_URL || 'https://git.mokoconsulting.tech' }}
|
||||||
|
|
||||||
permissions:
|
permissions:
|
||||||
contents: write
|
contents: write
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
bump:
|
bump:
|
||||||
name: Version Bump
|
name: Version Bump
|
||||||
runs-on: release
|
runs-on: release
|
||||||
if: >-
|
if: >-
|
||||||
!contains(github.event.head_commit.message, '[skip ci]') &&
|
!contains(github.event.head_commit.message, '[skip ci]') &&
|
||||||
!contains(github.event.head_commit.message, '[skip bump]') &&
|
!contains(github.event.head_commit.message, '[skip bump]') &&
|
||||||
!startsWith(github.event.head_commit.message, 'Merge pull request')
|
!startsWith(github.event.head_commit.message, 'Merge pull request')
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
|
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.MOKOGITEA_TOKEN }}
|
token: ${{ secrets.MOKOGITEA_TOKEN }}
|
||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
- name: Setup moko-platform tools
|
- name: Setup moko-platform tools
|
||||||
run: |
|
run: |
|
||||||
if [ -f "/opt/moko-platform/cli/version_bump.php" ] && [ -f "/opt/moko-platform/vendor/autoload.php" ]; then
|
if ! command -v composer &> /dev/null; then
|
||||||
echo "Using pre-installed /opt/moko-platform"
|
sudo apt-get update -qq && sudo apt-get install -y -qq php-cli php-mbstring php-xml php-zip php-curl composer >/dev/null 2>&1
|
||||||
echo "MOKO_CLI=/opt/moko-platform/cli" >> "$GITHUB_ENV"
|
fi
|
||||||
else
|
if [ -d "/opt/moko-platform/cli" ]; then
|
||||||
if ! command -v composer &> /dev/null; then
|
echo "MOKO_CLI=/opt/moko-platform/cli" >> "$GITHUB_ENV"
|
||||||
sudo apt-get update -qq && sudo apt-get install -y -qq php-cli php-mbstring php-xml php-zip php-curl composer >/dev/null 2>&1
|
else
|
||||||
fi
|
git clone --depth 1 --branch main --quiet \
|
||||||
rm -rf /tmp/moko-platform-api
|
"https://x-access-token:${{ secrets.MOKOGITEA_TOKEN }}@git.mokoconsulting.tech/MokoConsulting/moko-platform.git" \
|
||||||
git clone --depth 1 --branch main --quiet \
|
/tmp/moko-platform-api
|
||||||
"https://x-access-token:${{ secrets.MOKOGITEA_TOKEN }}@git.mokoconsulting.tech/MokoConsulting/moko-platform.git" \
|
cd /tmp/moko-platform-api && composer install --no-dev --no-interaction --quiet
|
||||||
/tmp/moko-platform-api
|
echo "MOKO_CLI=/tmp/moko-platform-api/cli" >> "$GITHUB_ENV"
|
||||||
cd /tmp/moko-platform-api && composer install --no-dev --no-interaction --quiet
|
fi
|
||||||
echo "MOKO_CLI=/tmp/moko-platform-api/cli" >> "$GITHUB_ENV"
|
|
||||||
fi
|
- name: Bump version
|
||||||
|
run: |
|
||||||
- name: Bump version
|
php ${MOKO_CLI}/version_auto_bump.php \
|
||||||
run: |
|
--path . --branch "${GITHUB_REF_NAME}" \
|
||||||
php ${MOKO_CLI}/version_auto_bump.php \
|
--token "${{ secrets.MOKOGITEA_TOKEN }}" \
|
||||||
--path . --branch "${GITHUB_REF_NAME}" \
|
--repo-url "https://x-access-token:${{ secrets.MOKOGITEA_TOKEN }}@git.mokoconsulting.tech/${{ github.repository }}.git"
|
||||||
--token "${{ secrets.MOKOGITEA_TOKEN }}" \
|
|
||||||
--repo-url "https://x-access-token:${{ secrets.MOKOGITEA_TOKEN }}@git.mokoconsulting.tech/${{ github.repository }}.git"
|
|
||||||
|
|||||||
@@ -71,26 +71,20 @@ jobs:
|
|||||||
MOKO_CLONE_TOKEN: ${{ secrets.MOKOGITEA_TOKEN }}
|
MOKO_CLONE_TOKEN: ${{ secrets.MOKOGITEA_TOKEN }}
|
||||||
MOKO_CLONE_HOST: git.mokoconsulting.tech/MokoConsulting
|
MOKO_CLONE_HOST: git.mokoconsulting.tech/MokoConsulting
|
||||||
run: |
|
run: |
|
||||||
if [ -f "/opt/moko-platform/cli/version_bump.php" ] && [ -f "/opt/moko-platform/vendor/autoload.php" ]; then
|
if ! command -v composer &> /dev/null; then
|
||||||
echo "Using pre-installed /opt/moko-platform"
|
sudo apt-get update -qq && sudo apt-get install -y -qq php-cli php-mbstring php-xml php-zip php-curl composer >/dev/null 2>&1
|
||||||
echo "MOKO_CLI=/opt/moko-platform/cli" >> "$GITHUB_ENV"
|
|
||||||
else
|
|
||||||
echo "Falling back to fresh clone"
|
|
||||||
if ! command -v composer &> /dev/null; then
|
|
||||||
sudo apt-get update -qq && sudo apt-get install -y -qq php-cli php-mbstring php-xml php-zip php-curl composer >/dev/null 2>&1
|
|
||||||
fi
|
|
||||||
rm -rf /tmp/moko-platform-api
|
|
||||||
git clone --depth 1 --branch main --quiet \
|
|
||||||
"https://x-access-token:${MOKO_CLONE_TOKEN}@${MOKO_CLONE_HOST}/moko-platform.git" \
|
|
||||||
/tmp/moko-platform-api
|
|
||||||
cd /tmp/moko-platform-api
|
|
||||||
composer install --no-dev --no-interaction --quiet
|
|
||||||
echo "MOKO_CLI=/tmp/moko-platform-api/cli" >> "$GITHUB_ENV"
|
|
||||||
fi
|
fi
|
||||||
|
# Always fetch latest CLI tools — never use stale cache from previous runs
|
||||||
|
rm -rf /tmp/moko-platform-api
|
||||||
|
git clone --depth 1 --branch main --quiet \
|
||||||
|
"https://x-access-token:${MOKO_CLONE_TOKEN}@${MOKO_CLONE_HOST}/moko-platform.git" \
|
||||||
|
/tmp/moko-platform-api
|
||||||
|
cd /tmp/moko-platform-api
|
||||||
|
composer install --no-dev --no-interaction --quiet
|
||||||
|
|
||||||
- name: Rename branch to rc
|
- name: Rename branch to rc
|
||||||
run: |
|
run: |
|
||||||
php ${MOKO_CLI}/branch_rename.php \
|
php /tmp/moko-platform-api/cli/branch_rename.php \
|
||||||
--from "${{ github.event.pull_request.head.ref || 'dev' }}" --to rc \
|
--from "${{ github.event.pull_request.head.ref || 'dev' }}" --to rc \
|
||||||
--token "${{ secrets.MOKOGITEA_TOKEN }}" \
|
--token "${{ secrets.MOKOGITEA_TOKEN }}" \
|
||||||
--api-base "${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}" \
|
--api-base "${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}" \
|
||||||
@@ -106,7 +100,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Publish RC release
|
- name: Publish RC release
|
||||||
run: |
|
run: |
|
||||||
php ${MOKO_CLI}/release_publish.php \
|
php /tmp/moko-platform-api/cli/release_publish.php \
|
||||||
--path . --stability rc --bump minor --branch rc \
|
--path . --stability rc --bump minor --branch rc \
|
||||||
--token "${{ secrets.MOKOGITEA_TOKEN }}" \
|
--token "${{ secrets.MOKOGITEA_TOKEN }}" \
|
||||||
--skip-update-stream
|
--skip-update-stream
|
||||||
@@ -157,63 +151,26 @@ jobs:
|
|||||||
MOKO_CLONE_HOST: git.mokoconsulting.tech/MokoConsulting
|
MOKO_CLONE_HOST: git.mokoconsulting.tech/MokoConsulting
|
||||||
COMPOSER_AUTH: '{"github-oauth":{"github.com":"${{ secrets.GH_MIRROR_TOKEN }}"}}'
|
COMPOSER_AUTH: '{"github-oauth":{"github.com":"${{ secrets.GH_MIRROR_TOKEN }}"}}'
|
||||||
run: |
|
run: |
|
||||||
if [ -f "/opt/moko-platform/cli/version_bump.php" ] && [ -f "/opt/moko-platform/vendor/autoload.php" ]; then
|
# Ensure PHP + Composer are available
|
||||||
echo "Using pre-installed /opt/moko-platform"
|
if ! command -v composer &> /dev/null; then
|
||||||
echo "MOKO_CLI=/opt/moko-platform/cli" >> "$GITHUB_ENV"
|
sudo apt-get update -qq && sudo apt-get install -y -qq php-cli php-mbstring php-xml php-zip php-curl composer >/dev/null 2>&1
|
||||||
else
|
|
||||||
echo "Falling back to fresh clone"
|
|
||||||
if ! command -v composer &> /dev/null; then
|
|
||||||
sudo apt-get update -qq && sudo apt-get install -y -qq php-cli php-mbstring php-xml php-zip php-curl composer >/dev/null 2>&1
|
|
||||||
fi
|
|
||||||
rm -rf /tmp/moko-platform-api
|
|
||||||
git clone --depth 1 --branch main --quiet \
|
|
||||||
"https://x-access-token:${MOKO_CLONE_TOKEN}@${MOKO_CLONE_HOST}/moko-platform.git" \
|
|
||||||
/tmp/moko-platform-api
|
|
||||||
cd /tmp/moko-platform-api
|
|
||||||
composer install --no-dev --no-interaction --quiet
|
|
||||||
echo "MOKO_CLI=/tmp/moko-platform-api/cli" >> "$GITHUB_ENV"
|
|
||||||
fi
|
fi
|
||||||
|
# Always fetch latest CLI tools — never use stale cache from previous runs
|
||||||
|
rm -rf /tmp/moko-platform-api
|
||||||
|
git clone --depth 1 --branch main --quiet \
|
||||||
|
"https://x-access-token:${MOKO_CLONE_TOKEN}@${MOKO_CLONE_HOST}/moko-platform.git" \
|
||||||
|
/tmp/moko-platform-api
|
||||||
|
cd /tmp/moko-platform-api
|
||||||
|
composer install --no-dev --no-interaction --quiet
|
||||||
|
|
||||||
|
|
||||||
- name: "Publish stable release"
|
- name: "Publish stable release"
|
||||||
run: |
|
run: |
|
||||||
php ${MOKO_CLI}/release_publish.php \
|
php /tmp/moko-platform-api/cli/release_publish.php \
|
||||||
--path . --stability stable --bump minor --branch main \
|
--path . --stability stable --bump minor --branch main \
|
||||||
--token "${{ secrets.MOKOGITEA_TOKEN }}" \
|
--token "${{ secrets.MOKOGITEA_TOKEN }}" \
|
||||||
--skip-update-stream
|
--skip-update-stream
|
||||||
|
|
||||||
- name: Update release notes from CHANGELOG.md
|
|
||||||
run: |
|
|
||||||
API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}"
|
|
||||||
|
|
||||||
# Extract [Unreleased] section from changelog
|
|
||||||
if [ -f "CHANGELOG.md" ]; then
|
|
||||||
NOTES=$(awk '/^## \[Unreleased\]/{found=1; next} /^## \[/{if(found) exit} found{print}' CHANGELOG.md)
|
|
||||||
[ -z "$NOTES" ] && NOTES="Stable release"
|
|
||||||
else
|
|
||||||
NOTES="Stable release"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Update release body via API
|
|
||||||
RELEASE_ID=$(curl -sf -H "Authorization: token ${{ secrets.MOKOGITEA_TOKEN }}" \
|
|
||||||
"${API_BASE}/releases/tags/stable" | python3 -c "import json,sys; print(json.load(sys.stdin).get('id',''))" 2>/dev/null || true)
|
|
||||||
|
|
||||||
if [ -n "$RELEASE_ID" ]; then
|
|
||||||
python3 -c "
|
|
||||||
import json, urllib.request
|
|
||||||
body = open('/dev/stdin').read()
|
|
||||||
payload = json.dumps({'body': body}).encode()
|
|
||||||
req = urllib.request.Request(
|
|
||||||
'${API_BASE}/releases/${RELEASE_ID}',
|
|
||||||
data=payload, method='PATCH',
|
|
||||||
headers={
|
|
||||||
'Authorization': 'token ${{ secrets.MOKOGITEA_TOKEN }}',
|
|
||||||
'Content-Type': 'application/json'
|
|
||||||
})
|
|
||||||
urllib.request.urlopen(req)
|
|
||||||
" <<< "$NOTES"
|
|
||||||
echo "Release notes updated from CHANGELOG.md"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# -- STEP 9: Mirror to GitHub (stable only) --------------------------------
|
# -- STEP 9: Mirror to GitHub (stable only) --------------------------------
|
||||||
- name: "Step 9: Mirror release to GitHub"
|
- name: "Step 9: Mirror release to GitHub"
|
||||||
if: >-
|
if: >-
|
||||||
@@ -225,7 +182,7 @@ jobs:
|
|||||||
RELEASE_TAG="${{ steps.version.outputs.release_tag }}"
|
RELEASE_TAG="${{ steps.version.outputs.release_tag }}"
|
||||||
GH_REPO="${{ vars.GH_MIRROR_REPO || github.repository }}"
|
GH_REPO="${{ vars.GH_MIRROR_REPO || github.repository }}"
|
||||||
API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}"
|
API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}"
|
||||||
php ${MOKO_CLI}/release_mirror.php \
|
php /tmp/moko-platform-api/cli/release_mirror.php \
|
||||||
--version "$VERSION" --tag "$RELEASE_TAG" \
|
--version "$VERSION" --tag "$RELEASE_TAG" \
|
||||||
--token "${{ secrets.MOKOGITEA_TOKEN }}" --api-base "$API_BASE" \
|
--token "${{ secrets.MOKOGITEA_TOKEN }}" --api-base "$API_BASE" \
|
||||||
--gh-token "${{ secrets.GH_MIRROR_TOKEN }}" --gh-repo "$GH_REPO" \
|
--gh-token "${{ secrets.GH_MIRROR_TOKEN }}" --gh-repo "$GH_REPO" \
|
||||||
@@ -299,7 +256,7 @@ jobs:
|
|||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
run: |
|
run: |
|
||||||
API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}"
|
API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}"
|
||||||
php ${MOKO_CLI}/version_reset_dev.php \
|
php /tmp/moko-platform-api/cli/version_reset_dev.php \
|
||||||
--token "${{ secrets.MOKOGITEA_TOKEN }}" --api-base "${API_BASE}" \
|
--token "${{ secrets.MOKOGITEA_TOKEN }}" --api-base "${API_BASE}" \
|
||||||
--branch dev --path . 2>&1 || true
|
--branch dev --path . 2>&1 || true
|
||||||
|
|
||||||
|
|||||||
@@ -412,12 +412,6 @@ jobs:
|
|||||||
if: always()
|
if: always()
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
sparse-checkout: automation/ci-issue-reporter.sh
|
|
||||||
sparse-checkout-cone-mode: false
|
|
||||||
|
|
||||||
- name: Check gate results
|
- name: Check gate results
|
||||||
run: |
|
run: |
|
||||||
{
|
{
|
||||||
@@ -443,46 +437,3 @@ jobs:
|
|||||||
echo "::error::One or more CI gates failed"
|
echo "::error::One or more CI gates failed"
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
- name: "File issues for failed gates"
|
|
||||||
if: >-
|
|
||||||
always() &&
|
|
||||||
(needs.code-quality.result == 'failure' ||
|
|
||||||
needs.tests.result == 'failure' ||
|
|
||||||
needs.self-health.result == 'failure' ||
|
|
||||||
needs.governance.result == 'failure' ||
|
|
||||||
needs.templates.result == 'failure')
|
|
||||||
env:
|
|
||||||
GITEA_TOKEN: ${{ secrets.MOKOGITEA_TOKEN }}
|
|
||||||
GITEA_URL: ${{ vars.GITEA_URL || 'https://git.mokoconsulting.tech' }}
|
|
||||||
run: |
|
|
||||||
chmod +x automation/ci-issue-reporter.sh
|
|
||||||
REPORTER="./automation/ci-issue-reporter.sh"
|
|
||||||
WF="Platform CI"
|
|
||||||
|
|
||||||
report_gate() {
|
|
||||||
local gate="$1" result="$2" details="$3"
|
|
||||||
if [ "$result" = "failure" ]; then
|
|
||||||
"$REPORTER" --gate "$gate" --details "$details" --workflow "$WF" --severity error
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
report_gate "Code Quality" \
|
|
||||||
"${{ needs.code-quality.result }}" \
|
|
||||||
"PHPCS (PSR-12), PHPStan, or PHP syntax checks failed. Run \`composer check\` locally to reproduce."
|
|
||||||
|
|
||||||
report_gate "Unit Tests" \
|
|
||||||
"${{ needs.tests.result }}" \
|
|
||||||
"PHPUnit tests failed on one or more PHP versions (8.1, 8.2, 8.3). Run \`vendor/bin/phpunit --testdox\` locally."
|
|
||||||
|
|
||||||
report_gate "Self-Health" \
|
|
||||||
"${{ needs.self-health.result }}" \
|
|
||||||
"Self-health score fell below the 80% threshold. Run \`php bin/moko health -- --path .\` locally."
|
|
||||||
|
|
||||||
report_gate "Governance" \
|
|
||||||
"${{ needs.governance.result }}" \
|
|
||||||
"Governance checks failed (license headers, secrets, or version consistency). Check the CI run summary for specifics."
|
|
||||||
|
|
||||||
report_gate "Template Integrity" \
|
|
||||||
"${{ needs.templates.result }}" \
|
|
||||||
"Workflow or gitignore templates failed YAML validation or are missing required entries."
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@
|
|||||||
# INGROUP: moko-platform.Release
|
# INGROUP: moko-platform.Release
|
||||||
# REPO: https://git.mokoconsulting.tech/MokoConsulting/moko-platform
|
# REPO: https://git.mokoconsulting.tech/MokoConsulting/moko-platform
|
||||||
# PATH: /templates/workflows/universal/pre-release.yml.template
|
# PATH: /templates/workflows/universal/pre-release.yml.template
|
||||||
# VERSION: 05.01.00
|
# VERSION: 09.23.00
|
||||||
# BRIEF: Manual pre-release -- builds dev/alpha/beta/rc packages from any branch
|
# BRIEF: Manual pre-release -- builds dev/alpha/beta/rc packages from any branch
|
||||||
|
|
||||||
name: "Universal: Pre-Release"
|
name: "Universal: Pre-Release"
|
||||||
@@ -17,10 +17,6 @@ on:
|
|||||||
types: [closed]
|
types: [closed]
|
||||||
branches:
|
branches:
|
||||||
- dev
|
- dev
|
||||||
pull_request_target:
|
|
||||||
types: [synchronize, opened, reopened]
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
inputs:
|
inputs:
|
||||||
stability:
|
stability:
|
||||||
@@ -47,8 +43,7 @@ jobs:
|
|||||||
runs-on: release
|
runs-on: release
|
||||||
if: >-
|
if: >-
|
||||||
github.event_name == 'workflow_dispatch' ||
|
github.event_name == 'workflow_dispatch' ||
|
||||||
(github.event_name == 'pull_request' && github.event.pull_request.merged == true && github.event.pull_request.base.ref == 'dev') ||
|
(github.event.pull_request.merged == true && github.event.pull_request.base.ref == 'dev')
|
||||||
(github.event_name == 'pull_request_target' && github.event.pull_request.base.ref == 'main')
|
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
@@ -56,29 +51,22 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
token: ${{ secrets.MOKOGITEA_TOKEN }}
|
token: ${{ secrets.MOKOGITEA_TOKEN }}
|
||||||
ref: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || '' }}
|
|
||||||
|
|
||||||
- name: Setup moko-platform tools
|
- name: Setup moko-platform tools
|
||||||
env:
|
env:
|
||||||
MOKO_CLONE_TOKEN: ${{ secrets.MOKOGITEA_TOKEN }}
|
MOKO_CLONE_TOKEN: ${{ secrets.MOKOGITEA_TOKEN }}
|
||||||
MOKO_CLONE_HOST: git.mokoconsulting.tech/MokoConsulting
|
MOKO_CLONE_HOST: git.mokoconsulting.tech/MokoConsulting
|
||||||
run: |
|
run: |
|
||||||
# Use pre-installed /opt/moko-platform if available (updated by cron every 6h)
|
if ! command -v composer &> /dev/null; then
|
||||||
if [ -f “/opt/moko-platform/cli/version_bump.php” ] && [ -f “/opt/moko-platform/vendor/autoload.php” ]; then
|
sudo apt-get update -qq && sudo apt-get install -y -qq php-cli php-mbstring php-xml php-zip php-curl composer >/dev/null 2>&1
|
||||||
echo “Using pre-installed /opt/moko-platform”
|
|
||||||
echo “MOKO_CLI=/opt/moko-platform/cli” >> “$GITHUB_ENV”
|
|
||||||
else
|
|
||||||
echo “Falling back to fresh clone”
|
|
||||||
if ! command -v composer &> /dev/null; then
|
|
||||||
sudo apt-get update -qq && sudo apt-get install -y -qq php-cli php-mbstring php-xml php-zip php-curl composer >/dev/null 2>&1
|
|
||||||
fi
|
|
||||||
rm -rf /tmp/moko-platform-api
|
|
||||||
git clone --depth 1 --branch main --quiet \
|
|
||||||
“https://x-access-token:${MOKO_CLONE_TOKEN}@${MOKO_CLONE_HOST}/moko-platform.git” \
|
|
||||||
/tmp/moko-platform-api
|
|
||||||
cd /tmp/moko-platform-api && composer install --no-dev --no-interaction --quiet
|
|
||||||
echo “MOKO_CLI=/tmp/moko-platform-api/cli” >> “$GITHUB_ENV”
|
|
||||||
fi
|
fi
|
||||||
|
# Always fetch latest CLI tools — never use stale cache from previous runs
|
||||||
|
rm -rf /tmp/moko-platform-api
|
||||||
|
git clone --depth 1 --branch main --quiet \
|
||||||
|
"https://x-access-token:${MOKO_CLONE_TOKEN}@${MOKO_CLONE_HOST}/moko-platform.git" \
|
||||||
|
/tmp/moko-platform-api
|
||||||
|
cd /tmp/moko-platform-api && composer install --no-dev --no-interaction --quiet
|
||||||
|
echo "MOKO_CLI=/tmp/moko-platform-api/cli" >> "$GITHUB_ENV"
|
||||||
|
|
||||||
- name: Detect platform
|
- name: Detect platform
|
||||||
id: platform
|
id: platform
|
||||||
@@ -88,40 +76,31 @@ jobs:
|
|||||||
- name: Resolve metadata and bump version
|
- name: Resolve metadata and bump version
|
||||||
id: meta
|
id: meta
|
||||||
run: |
|
run: |
|
||||||
# Auto-detect stability: RC for PRs targeting main, else use input or default to development
|
STABILITY="${{ inputs.stability || 'development' }}"
|
||||||
if [ "${{ github.event_name }}" = "pull_request_target" ] && [ "${{ github.event.pull_request.base.ref }}" = "main" ]; then
|
|
||||||
STABILITY="release-candidate"
|
|
||||||
else
|
|
||||||
STABILITY="${{ inputs.stability || 'development' }}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
case "$STABILITY" in
|
case "$STABILITY" in
|
||||||
development) SUFFIX="-dev"; TAG="development" ;;
|
development) TAG="development" ;;
|
||||||
alpha) SUFFIX="-alpha"; TAG="alpha" ;;
|
alpha) TAG="alpha" ;;
|
||||||
beta) SUFFIX="-beta"; TAG="beta" ;;
|
beta) TAG="beta" ;;
|
||||||
release-candidate) SUFFIX="-rc"; TAG="release-candidate" ;;
|
release-candidate) TAG="release-candidate" ;;
|
||||||
esac
|
esac
|
||||||
|
|
||||||
# Bump version via CLI: patch for dev/alpha/beta, minor for RC
|
# Bump version: patch for dev/alpha/beta, minor for RC
|
||||||
case "$STABILITY" in
|
case "$STABILITY" in
|
||||||
release-candidate) BUMP="minor" ;;
|
release-candidate) php ${MOKO_CLI}/version_bump.php --path . --minor 2>/dev/null || true ;;
|
||||||
*) BUMP="patch" ;;
|
*) php ${MOKO_CLI}/version_bump.php --path . 2>/dev/null || true ;;
|
||||||
esac
|
esac
|
||||||
|
|
||||||
php ${MOKO_CLI}/version_bump.php --path . $([ "$BUMP" = "minor" ] && echo "--minor") 2>/dev/null || true
|
# Set stability suffix and fix consistency
|
||||||
|
VERSION=$(php ${MOKO_CLI}/version_read.php --path . 2>/dev/null || echo '00.00.01')
|
||||||
# Set stability suffix and verify consistency
|
|
||||||
VERSION=$(php ${MOKO_CLI}/version_read.php --path . 2>/dev/null || echo "00.00.01")
|
|
||||||
VERSION=$(echo "$VERSION" | sed 's/-\(dev\|alpha\|beta\|rc\)$//')
|
VERSION=$(echo "$VERSION" | sed 's/-\(dev\|alpha\|beta\|rc\)$//')
|
||||||
|
|
||||||
php ${MOKO_CLI}/version_set_platform.php \
|
php ${MOKO_CLI}/version_set_platform.php \
|
||||||
--path . --version "$VERSION" --branch "${{ github.ref_name }}" --stability "$STABILITY" 2>/dev/null || true
|
--path . --version "$VERSION" --branch "${{ github.ref_name }}" --stability "$STABILITY" 2>/dev/null || true
|
||||||
php ${MOKO_CLI}/version_check.php --path . --fix 2>/dev/null || true
|
php ${MOKO_CLI}/version_check.php --path . --fix 2>/dev/null || true
|
||||||
|
|
||||||
# Append suffix for output
|
# Read final version with suffix
|
||||||
if [ -n "$SUFFIX" ]; then
|
VERSION=$(php ${MOKO_CLI}/version_read.php --path . 2>/dev/null)
|
||||||
VERSION="${VERSION}${SUFFIX}"
|
[ -z "$VERSION" ] && VERSION="00.00.01"
|
||||||
fi
|
|
||||||
|
|
||||||
# Commit version bump
|
# Commit version bump
|
||||||
git config --local user.email "gitea-actions[bot]@mokoconsulting.tech"
|
git config --local user.email "gitea-actions[bot]@mokoconsulting.tech"
|
||||||
@@ -146,12 +125,11 @@ jobs:
|
|||||||
|
|
||||||
echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
|
echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
|
||||||
echo "stability=${STABILITY}" >> "$GITHUB_OUTPUT"
|
echo "stability=${STABILITY}" >> "$GITHUB_OUTPUT"
|
||||||
echo "suffix=${SUFFIX}" >> "$GITHUB_OUTPUT"
|
|
||||||
echo "tag=${TAG}" >> "$GITHUB_OUTPUT"
|
echo "tag=${TAG}" >> "$GITHUB_OUTPUT"
|
||||||
echo "zip_name=${ZIP_NAME}" >> "$GITHUB_OUTPUT"
|
echo "zip_name=${ZIP_NAME}" >> "$GITHUB_OUTPUT"
|
||||||
echo "ext_element=${EXT_ELEMENT}" >> "$GITHUB_OUTPUT"
|
echo "ext_element=${EXT_ELEMENT}" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
echo "=== Pre-Release: ${EXT_ELEMENT} ${VERSION}${SUFFIX} ==="
|
echo "=== Pre-Release: ${EXT_ELEMENT} ${VERSION} ==="
|
||||||
|
|
||||||
- name: Create release
|
- name: Create release
|
||||||
id: release
|
id: release
|
||||||
@@ -164,41 +142,6 @@ jobs:
|
|||||||
--token "${{ secrets.MOKOGITEA_TOKEN }}" --api-base "$API_BASE" \
|
--token "${{ secrets.MOKOGITEA_TOKEN }}" --api-base "$API_BASE" \
|
||||||
--repo "${GITEA_REPO}" --branch dev --prerelease
|
--repo "${GITEA_REPO}" --branch dev --prerelease
|
||||||
|
|
||||||
- name: Update release notes from CHANGELOG.md
|
|
||||||
run: |
|
|
||||||
TAG="${{ steps.meta.outputs.tag }}"
|
|
||||||
VERSION="${{ steps.meta.outputs.version }}"
|
|
||||||
API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}"
|
|
||||||
|
|
||||||
# Extract [Unreleased] section from changelog (everything between [Unreleased] and next ## heading)
|
|
||||||
if [ -f "CHANGELOG.md" ]; then
|
|
||||||
NOTES=$(awk '/^## \[Unreleased\]/{found=1; next} /^## \[/{if(found) exit} found{print}' CHANGELOG.md)
|
|
||||||
[ -z "$NOTES" ] && NOTES="Release ${VERSION}"
|
|
||||||
else
|
|
||||||
NOTES="Release ${VERSION}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Update release body via API
|
|
||||||
RELEASE_ID=$(curl -sf -H "Authorization: token ${{ secrets.MOKOGITEA_TOKEN }}" \
|
|
||||||
"${API_BASE}/releases/tags/${TAG}" | python3 -c "import json,sys; print(json.load(sys.stdin).get('id',''))" 2>/dev/null || true)
|
|
||||||
|
|
||||||
if [ -n "$RELEASE_ID" ]; then
|
|
||||||
python3 -c "
|
|
||||||
import json, urllib.request
|
|
||||||
body = open('/dev/stdin').read()
|
|
||||||
payload = json.dumps({'body': body}).encode()
|
|
||||||
req = urllib.request.Request(
|
|
||||||
'${API_BASE}/releases/${RELEASE_ID}',
|
|
||||||
data=payload, method='PATCH',
|
|
||||||
headers={
|
|
||||||
'Authorization': 'token ${{ secrets.MOKOGITEA_TOKEN }}',
|
|
||||||
'Content-Type': 'application/json'
|
|
||||||
})
|
|
||||||
urllib.request.urlopen(req)
|
|
||||||
" <<< "$NOTES"
|
|
||||||
echo "Release notes updated from CHANGELOG.md"
|
|
||||||
fi
|
|
||||||
|
|
||||||
- name: Build package and upload
|
- name: Build package and upload
|
||||||
id: package
|
id: package
|
||||||
run: |
|
run: |
|
||||||
|
|||||||
@@ -0,0 +1,302 @@
|
|||||||
|
# Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
#
|
||||||
|
# FILE INFORMATION
|
||||||
|
# DEFGROUP: Gitea.Workflow
|
||||||
|
# INGROUP: moko-platform.Universal
|
||||||
|
# REPO: https://git.mokoconsulting.tech/MokoConsulting/moko-platform
|
||||||
|
# PATH: /templates/workflows/update-server.yml
|
||||||
|
# VERSION: 09.23.00
|
||||||
|
# BRIEF: Pre-release build + update server XML for dev/alpha/beta/rc branches
|
||||||
|
#
|
||||||
|
# Thin wrapper around moko-platform CLI tools.
|
||||||
|
# Builds packages, updates updates.xml, and optionally deploys via SFTP.
|
||||||
|
#
|
||||||
|
# Joomla filters update entries by the user's "Minimum Stability" setting.
|
||||||
|
|
||||||
|
name: "Update Server"
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- 'dev'
|
||||||
|
- 'dev/**'
|
||||||
|
- 'alpha/**'
|
||||||
|
- 'beta/**'
|
||||||
|
- 'rc/**'
|
||||||
|
paths:
|
||||||
|
- 'src/**'
|
||||||
|
- 'htdocs/**'
|
||||||
|
pull_request:
|
||||||
|
types: [closed]
|
||||||
|
branches:
|
||||||
|
- 'dev'
|
||||||
|
- 'dev/**'
|
||||||
|
- 'alpha/**'
|
||||||
|
- 'beta/**'
|
||||||
|
- 'rc/**'
|
||||||
|
paths:
|
||||||
|
- 'src/**'
|
||||||
|
- 'htdocs/**'
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
stability:
|
||||||
|
description: 'Stability tag'
|
||||||
|
required: true
|
||||||
|
default: 'development'
|
||||||
|
type: choice
|
||||||
|
options:
|
||||||
|
- development
|
||||||
|
- alpha
|
||||||
|
- beta
|
||||||
|
- rc
|
||||||
|
- stable
|
||||||
|
|
||||||
|
env:
|
||||||
|
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
|
||||||
|
GITEA_URL: ${{ vars.GITEA_URL || 'https://git.mokoconsulting.tech' }}
|
||||||
|
GITEA_ORG: ${{ vars.GITEA_ORG || github.repository_owner }}
|
||||||
|
GITEA_REPO: ${{ vars.GITEA_REPO || github.event.repository.name }}
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
update-xml:
|
||||||
|
name: Update Server
|
||||||
|
runs-on: release
|
||||||
|
if: >-
|
||||||
|
github.event.pull_request.merged == true || github.event_name == 'workflow_dispatch' || github.event_name == 'push'
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
token: ${{ secrets.MOKOGITEA_TOKEN }}
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Setup moko-platform tools
|
||||||
|
env:
|
||||||
|
MOKO_CLONE_TOKEN: ${{ secrets.MOKOGITEA_TOKEN }}
|
||||||
|
MOKO_CLONE_HOST: git.mokoconsulting.tech/MokoConsulting
|
||||||
|
COMPOSER_AUTH: '{"http-basic":{"git.mokoconsulting.tech":{"username":"token","password":"${{ secrets.MOKOGITEA_TOKEN }}"}}}'
|
||||||
|
run: |
|
||||||
|
if ! command -v composer &> /dev/null; then
|
||||||
|
sudo apt-get update -qq && sudo apt-get install -y -qq php-cli php-mbstring php-xml php-zip php-curl composer >/dev/null 2>&1
|
||||||
|
fi
|
||||||
|
# Always fetch latest CLI tools — never use stale cache from previous runs
|
||||||
|
rm -rf /tmp/moko-platform
|
||||||
|
git clone --depth 1 --branch main --quiet \
|
||||||
|
"https://x-access-token:${MOKO_CLONE_TOKEN}@${MOKO_CLONE_HOST}/moko-platform.git" \
|
||||||
|
/tmp/moko-platform 2>/dev/null || true
|
||||||
|
if [ -d "/tmp/moko-platform" ] && [ -f "/tmp/moko-platform/composer.json" ]; then
|
||||||
|
cd /tmp/moko-platform && composer install --no-dev --no-interaction --quiet 2>/dev/null || true
|
||||||
|
fi
|
||||||
|
echo "MOKO_CLI=/tmp/moko-platform/cli" >> "$GITHUB_ENV"
|
||||||
|
|
||||||
|
- name: Detect platform
|
||||||
|
id: platform
|
||||||
|
run: php ${MOKO_CLI}/manifest_read.php --path . --github-output
|
||||||
|
|
||||||
|
- name: Resolve stability and bump version
|
||||||
|
id: meta
|
||||||
|
run: |
|
||||||
|
BRANCH="${{ github.ref_name }}"
|
||||||
|
|
||||||
|
# Configure git for bot pushes
|
||||||
|
git config --local user.email "gitea-actions[bot]@mokoconsulting.tech"
|
||||||
|
git config --local user.name "gitea-actions[bot]"
|
||||||
|
git remote set-url origin "https://x-access-token:${{ secrets.MOKOGITEA_TOKEN }}@git.mokoconsulting.tech/${{ github.repository }}.git"
|
||||||
|
|
||||||
|
# Determine stability from branch or manual input
|
||||||
|
if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
|
||||||
|
STABILITY="${{ inputs.stability }}"
|
||||||
|
elif [[ "$BRANCH" == rc/* ]]; then
|
||||||
|
STABILITY="rc"
|
||||||
|
elif [[ "$BRANCH" == beta/* ]]; then
|
||||||
|
STABILITY="beta"
|
||||||
|
elif [[ "$BRANCH" == alpha/* ]]; then
|
||||||
|
STABILITY="alpha"
|
||||||
|
else
|
||||||
|
STABILITY="development"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Gitea release tag per stability
|
||||||
|
case "$STABILITY" in
|
||||||
|
development) TAG="development" ;;
|
||||||
|
alpha) TAG="alpha" ;;
|
||||||
|
beta) TAG="beta" ;;
|
||||||
|
rc) TAG="release-candidate" ;;
|
||||||
|
*) TAG="stable" ;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
# Bump patch, set platform suffix, fix consistency — version_bump preserves suffix
|
||||||
|
php ${MOKO_CLI}/version_set_platform.php \
|
||||||
|
--path . --version "$(php ${MOKO_CLI}/version_read.php --path . 2>/dev/null || echo '00.00.01')" \
|
||||||
|
--branch "$BRANCH" --stability "$STABILITY" 2>/dev/null || true
|
||||||
|
php ${MOKO_CLI}/version_bump.php --path . 2>/dev/null || true
|
||||||
|
php ${MOKO_CLI}/version_check.php --path . --fix 2>/dev/null || true
|
||||||
|
|
||||||
|
# Read final version (includes suffix, e.g. 01.02.15-dev)
|
||||||
|
VERSION=$(php ${MOKO_CLI}/version_read.php --path . 2>/dev/null || echo "00.00.01")
|
||||||
|
|
||||||
|
echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "stability=${STABILITY}" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "tag=${TAG}" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
|
# Commit version bump if changed
|
||||||
|
git add -A
|
||||||
|
git diff --cached --quiet || {
|
||||||
|
git commit -m "chore(version): auto-bump ${VERSION} [skip ci]" \
|
||||||
|
--author="gitea-actions[bot] <gitea-actions[bot]@mokoconsulting.tech>"
|
||||||
|
git push
|
||||||
|
}
|
||||||
|
|
||||||
|
- name: Create release and upload package
|
||||||
|
id: package
|
||||||
|
run: |
|
||||||
|
VERSION="${{ steps.meta.outputs.version }}"
|
||||||
|
TAG="${{ steps.meta.outputs.tag }}"
|
||||||
|
API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}"
|
||||||
|
|
||||||
|
# Create or update Gitea release
|
||||||
|
php ${MOKO_CLI}/release_create.php \
|
||||||
|
--path . --version "$VERSION" --tag "$TAG" \
|
||||||
|
--token "${{ secrets.MOKOGITEA_TOKEN }}" --api-base "$API_BASE" \
|
||||||
|
--repo "${GITEA_REPO}" --branch "${{ github.ref_name }}" --prerelease
|
||||||
|
|
||||||
|
# Build package and upload
|
||||||
|
php ${MOKO_CLI}/release_package.php \
|
||||||
|
--path . --version "$VERSION" --tag "$TAG" \
|
||||||
|
--token "${{ secrets.MOKOGITEA_TOKEN }}" --api-base "$API_BASE" \
|
||||||
|
--repo "${GITEA_REPO}" --output /tmp || true
|
||||||
|
|
||||||
|
- name: Update updates.xml
|
||||||
|
if: steps.platform.outputs.platform == 'joomla'
|
||||||
|
run: |
|
||||||
|
VERSION="${{ steps.meta.outputs.version }}"
|
||||||
|
STABILITY="${{ steps.meta.outputs.stability }}"
|
||||||
|
SHA256="${{ steps.package.outputs.sha256_zip }}"
|
||||||
|
|
||||||
|
if [ ! -f "updates.xml" ]; then
|
||||||
|
echo "No updates.xml — skipping"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
SHA_FLAG=""
|
||||||
|
[ -n "$SHA256" ] && SHA_FLAG="--sha ${SHA256}"
|
||||||
|
|
||||||
|
php ${MOKO_CLI}/updates_xml_build.php \
|
||||||
|
--path . --version "${VERSION}" --stability "${STABILITY}" \
|
||||||
|
--gitea-url "${GITEA_URL}" --org "${GITEA_ORG}" --repo "${GITEA_REPO}" \
|
||||||
|
${SHA_FLAG}
|
||||||
|
|
||||||
|
# Commit and push updates.xml
|
||||||
|
git add updates.xml
|
||||||
|
git diff --cached --quiet || {
|
||||||
|
git commit -m "chore: update ${STABILITY} channel ${VERSION} [skip ci]"
|
||||||
|
git push
|
||||||
|
}
|
||||||
|
|
||||||
|
- name: Sync updates.xml to main
|
||||||
|
if: github.ref_name != 'main' && steps.platform.outputs.platform == 'joomla'
|
||||||
|
run: |
|
||||||
|
API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}"
|
||||||
|
GITEA_TOKEN="${{ secrets.MOKOGITEA_TOKEN }}"
|
||||||
|
|
||||||
|
FILE_SHA=$(curl -sf -H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
"${API_BASE}/contents/updates.xml?ref=main" | python3 -c "import sys,json; print(json.load(sys.stdin).get('sha',''))" 2>/dev/null || true)
|
||||||
|
|
||||||
|
if [ -n "$FILE_SHA" ] && [ -f "updates.xml" ]; then
|
||||||
|
python3 -c "
|
||||||
|
import base64, json, urllib.request, sys
|
||||||
|
with open('updates.xml', 'rb') as f:
|
||||||
|
content = base64.b64encode(f.read()).decode()
|
||||||
|
payload = json.dumps({
|
||||||
|
'content': content,
|
||||||
|
'sha': '${FILE_SHA}',
|
||||||
|
'message': 'chore: sync updates.xml from ${{ steps.meta.outputs.stability }} [skip ci]',
|
||||||
|
'branch': 'main'
|
||||||
|
}).encode()
|
||||||
|
req = urllib.request.Request(
|
||||||
|
'${API_BASE}/contents/updates.xml',
|
||||||
|
data=payload, method='PUT',
|
||||||
|
headers={
|
||||||
|
'Authorization': 'token ${GITEA_TOKEN}',
|
||||||
|
'Content-Type': 'application/json'
|
||||||
|
})
|
||||||
|
try:
|
||||||
|
urllib.request.urlopen(req)
|
||||||
|
print('updates.xml synced to main')
|
||||||
|
except Exception as e:
|
||||||
|
print(f'WARNING: sync to main failed: {e}', file=sys.stderr)
|
||||||
|
"
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: SFTP deploy to dev server
|
||||||
|
if: contains(github.ref, 'dev/') || github.ref == 'refs/heads/dev'
|
||||||
|
env:
|
||||||
|
DEV_HOST: ${{ vars.DEV_FTP_HOST }}
|
||||||
|
DEV_PATH: ${{ vars.DEV_FTP_PATH }}
|
||||||
|
DEV_SUFFIX: ${{ vars.DEV_FTP_SUFFIX }}
|
||||||
|
DEV_USER: ${{ vars.DEV_FTP_USERNAME }}
|
||||||
|
DEV_PORT: ${{ vars.DEV_FTP_PORT }}
|
||||||
|
DEV_KEY: ${{ secrets.DEV_FTP_KEY }}
|
||||||
|
DEV_PASS: ${{ secrets.DEV_FTP_PASSWORD }}
|
||||||
|
run: |
|
||||||
|
# Permission check: admin or maintain role required
|
||||||
|
ACTOR="${{ github.actor }}"
|
||||||
|
API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}"
|
||||||
|
|
||||||
|
PERMISSION=$(curl -sf -H "Authorization: token ${{ secrets.MOKOGITEA_TOKEN }}" \
|
||||||
|
"${API_BASE}/collaborators/${ACTOR}/permission" 2>/dev/null | \
|
||||||
|
python3 -c "import sys,json; print(json.load(sys.stdin).get('permission','read'))" 2>/dev/null || echo "read")
|
||||||
|
case "$PERMISSION" in
|
||||||
|
admin|maintain|write) ;;
|
||||||
|
*)
|
||||||
|
echo "Deploy denied: ${ACTOR} has '${PERMISSION}' — requires admin, maintain, or write"
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
[ -z "$DEV_HOST" ] || [ -z "$DEV_PATH" ] && { echo "DEV FTP not configured — skipping SFTP"; exit 0; }
|
||||||
|
|
||||||
|
SOURCE_DIR="src"
|
||||||
|
[ ! -d "$SOURCE_DIR" ] && SOURCE_DIR="htdocs"
|
||||||
|
[ ! -d "$SOURCE_DIR" ] && exit 0
|
||||||
|
|
||||||
|
PORT="${DEV_PORT:-22}"
|
||||||
|
REMOTE="${DEV_PATH%/}"
|
||||||
|
[ -n "$DEV_SUFFIX" ] && REMOTE="${REMOTE}/${DEV_SUFFIX#/}"
|
||||||
|
|
||||||
|
printf '{"host":"%s","port":%s,"username":"%s","remotePath":"%s"' \
|
||||||
|
"$DEV_HOST" "$PORT" "$DEV_USER" "$REMOTE" > /tmp/sftp-config.json
|
||||||
|
if [ -n "$DEV_KEY" ]; then
|
||||||
|
echo "$DEV_KEY" > /tmp/deploy_key && chmod 600 /tmp/deploy_key
|
||||||
|
printf ',"privateKeyPath":"/tmp/deploy_key"}' >> /tmp/sftp-config.json
|
||||||
|
else
|
||||||
|
printf ',"password":"%s"}' "$DEV_PASS" >> /tmp/sftp-config.json
|
||||||
|
fi
|
||||||
|
|
||||||
|
PLATFORM=$(php ${MOKO_CLI}/platform_detect.php --path . 2>/dev/null || true)
|
||||||
|
if [ "$PLATFORM" = "waas-component" ] && [ -f "${MOKO_CLI}/../deploy/deploy-joomla.php" ]; then
|
||||||
|
php ${MOKO_CLI}/../deploy/deploy-joomla.php --path . --src-dir "$SOURCE_DIR" --config /tmp/sftp-config.json
|
||||||
|
elif [ -f "${MOKO_CLI}/../deploy/deploy-sftp.php" ]; then
|
||||||
|
php ${MOKO_CLI}/../deploy/deploy-sftp.php --path . --src-dir "$SOURCE_DIR" --config /tmp/sftp-config.json
|
||||||
|
fi
|
||||||
|
rm -f /tmp/deploy_key /tmp/sftp-config.json
|
||||||
|
echo "SFTP deploy to dev complete" >> $GITHUB_STEP_SUMMARY
|
||||||
|
|
||||||
|
- name: Summary
|
||||||
|
if: always()
|
||||||
|
run: |
|
||||||
|
VERSION="${{ steps.meta.outputs.version }}"
|
||||||
|
STABILITY="${{ steps.meta.outputs.stability }}"
|
||||||
|
DISPLAY="${VERSION}"
|
||||||
|
echo "## Update Server" >> $GITHUB_STEP_SUMMARY
|
||||||
|
echo "" >> $GITHUB_STEP_SUMMARY
|
||||||
|
echo "| Field | Value |" >> $GITHUB_STEP_SUMMARY
|
||||||
|
echo "|-------|-------|" >> $GITHUB_STEP_SUMMARY
|
||||||
|
echo "| Stability | \`${STABILITY}\` |" >> $GITHUB_STEP_SUMMARY
|
||||||
|
echo "| Version | \`${DISPLAY}\` |" >> $GITHUB_STEP_SUMMARY
|
||||||
+3
-7
@@ -10,9 +10,11 @@ BRIEF: Release changelog
|
|||||||
-->
|
-->
|
||||||
|
|
||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
|
|
||||||
|
## [09.24.00] --- 2026-06-04
|
||||||
|
|
||||||
## [09.23] --- 2026-05-31
|
## [09.23] --- 2026-05-31
|
||||||
|
|
||||||
## [09.22] --- 2026-05-31
|
## [09.22] --- 2026-05-31
|
||||||
@@ -30,9 +32,3 @@ BRIEF: Release changelog
|
|||||||
## [09.21] --- 2026-05-30
|
## [09.21] --- 2026-05-30
|
||||||
|
|
||||||
## [09.20] --- 2026-05-30
|
## [09.20] --- 2026-05-30
|
||||||
|
|
||||||
## [09.19] --- 2026-05-30
|
|
||||||
|
|
||||||
## [09.18] --- 2026-05-30
|
|
||||||
|
|
||||||
## [09.17] --- 2026-05-30
|
|
||||||
|
|||||||
@@ -1,237 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
# ============================================================================
|
|
||||||
# Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
|
|
||||||
#
|
|
||||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
||||||
#
|
|
||||||
# FILE INFORMATION
|
|
||||||
# DEFGROUP: Automation.CI
|
|
||||||
# INGROUP: moko-platform.Automation
|
|
||||||
# REPO: https://git.mokoconsulting.tech/MokoConsulting/moko-platform
|
|
||||||
# PATH: /automation/ci-issue-reporter.sh
|
|
||||||
# VERSION: 09.23.00
|
|
||||||
# BRIEF: Creates or updates a Gitea issue when a CI gate fails.
|
|
||||||
# Deduplicates by searching open issues with the "ci-auto" label
|
|
||||||
# whose title matches the gate. If a matching issue exists, a comment
|
|
||||||
# is appended instead of opening a duplicate.
|
|
||||||
# ============================================================================
|
|
||||||
|
|
||||||
set -euo pipefail
|
|
||||||
|
|
||||||
# ── Defaults ────────────────────────────────────────────────────────────────
|
|
||||||
GITEA_URL="${GITEA_URL:-https://git.mokoconsulting.tech}"
|
|
||||||
GITEA_TOKEN="${GITEA_TOKEN:-}"
|
|
||||||
REPO="${GITHUB_REPOSITORY:-}"
|
|
||||||
RUN_URL="${GITHUB_SERVER_URL:-${GITEA_URL}}/${REPO}/actions/runs/${GITHUB_RUN_ID:-0}"
|
|
||||||
LABEL_NAME="ci-auto"
|
|
||||||
LABEL_COLOR="#e11d48"
|
|
||||||
|
|
||||||
GATE=""
|
|
||||||
DETAILS=""
|
|
||||||
SEVERITY="error"
|
|
||||||
WORKFLOW=""
|
|
||||||
|
|
||||||
# ── Parse arguments ─────────────────────────────────────────────────────────
|
|
||||||
usage() {
|
|
||||||
cat <<EOF
|
|
||||||
Usage: ci-issue-reporter.sh --gate NAME --details TEXT [OPTIONS]
|
|
||||||
|
|
||||||
Required:
|
|
||||||
--gate CI gate name (e.g. "Code Quality", "Self-Health")
|
|
||||||
--details Human-readable failure description
|
|
||||||
|
|
||||||
Optional:
|
|
||||||
--severity "error" (default) or "warning"
|
|
||||||
--workflow Workflow name for the issue title
|
|
||||||
--repo owner/repo (default: \$GITHUB_REPOSITORY)
|
|
||||||
--run-url URL to the CI run (auto-detected from env)
|
|
||||||
--token Gitea API token (default: \$GITEA_TOKEN)
|
|
||||||
--url Gitea base URL (default: \$GITEA_URL)
|
|
||||||
EOF
|
|
||||||
exit 1
|
|
||||||
}
|
|
||||||
|
|
||||||
while [[ $# -gt 0 ]]; do
|
|
||||||
case "$1" in
|
|
||||||
--gate) GATE="$2"; shift 2 ;;
|
|
||||||
--details) DETAILS="$2"; shift 2 ;;
|
|
||||||
--severity) SEVERITY="$2"; shift 2 ;;
|
|
||||||
--workflow) WORKFLOW="$2"; shift 2 ;;
|
|
||||||
--repo) REPO="$2"; shift 2 ;;
|
|
||||||
--run-url) RUN_URL="$2"; shift 2 ;;
|
|
||||||
--token) GITEA_TOKEN="$2"; shift 2 ;;
|
|
||||||
--url) GITEA_URL="$2"; shift 2 ;;
|
|
||||||
-h|--help) usage ;;
|
|
||||||
*) echo "Unknown option: $1"; usage ;;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
|
|
||||||
[[ -z "$GATE" ]] && { echo "ERROR: --gate is required"; usage; }
|
|
||||||
[[ -z "$DETAILS" ]] && { echo "ERROR: --details is required"; usage; }
|
|
||||||
[[ -z "$GITEA_TOKEN" ]] && { echo "ERROR: GITEA_TOKEN not set"; exit 1; }
|
|
||||||
[[ -z "$REPO" ]] && { echo "ERROR: GITHUB_REPOSITORY not set"; exit 1; }
|
|
||||||
|
|
||||||
API="${GITEA_URL}/api/v1/repos/${REPO}"
|
|
||||||
|
|
||||||
# ── Build title ─────────────────────────────────────────────────────────────
|
|
||||||
if [[ -n "$WORKFLOW" ]]; then
|
|
||||||
TITLE="[CI] ${WORKFLOW}: ${GATE} failed"
|
|
||||||
else
|
|
||||||
TITLE="[CI] ${GATE} failed"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# ── Ensure label exists ─────────────────────────────────────────────────────
|
|
||||||
ensure_label() {
|
|
||||||
local exists
|
|
||||||
exists=$(curl -sf -o /dev/null -w '%{http_code}' \
|
|
||||||
-H "Authorization: token ${GITEA_TOKEN}" \
|
|
||||||
"${API}/labels" 2>/dev/null || echo "000")
|
|
||||||
|
|
||||||
if [[ "$exists" == "200" ]]; then
|
|
||||||
# Check if label already exists
|
|
||||||
local found
|
|
||||||
found=$(curl -sf \
|
|
||||||
-H "Authorization: token ${GITEA_TOKEN}" \
|
|
||||||
"${API}/labels" 2>/dev/null \
|
|
||||||
| grep -o "\"name\":\"${LABEL_NAME}\"" || true)
|
|
||||||
|
|
||||||
if [[ -z "$found" ]]; then
|
|
||||||
curl -sf -X POST \
|
|
||||||
-H "Authorization: token ${GITEA_TOKEN}" \
|
|
||||||
-H "Content-Type: application/json" \
|
|
||||||
"${API}/labels" \
|
|
||||||
-d "{\"name\":\"${LABEL_NAME}\",\"color\":\"${LABEL_COLOR}\",\"description\":\"Auto-created by CI issue reporter\"}" \
|
|
||||||
> /dev/null 2>&1 || true
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# ── Search for existing open issue ──────────────────────────────────────────
|
|
||||||
find_existing_issue() {
|
|
||||||
# URL-encode the gate name for the query
|
|
||||||
local query
|
|
||||||
query=$(printf '%s' "[CI] ${GATE}" | sed 's/ /%20/g; s/\[/%5B/g; s/\]/%5D/g')
|
|
||||||
|
|
||||||
local response
|
|
||||||
response=$(curl -sf \
|
|
||||||
-H "Authorization: token ${GITEA_TOKEN}" \
|
|
||||||
"${API}/issues?type=issues&state=open&labels=${LABEL_NAME}&q=${query}&limit=5" \
|
|
||||||
2>/dev/null || echo "[]")
|
|
||||||
|
|
||||||
# Extract the first matching issue number
|
|
||||||
echo "$response" \
|
|
||||||
| grep -oP '"number":\s*\K[0-9]+' \
|
|
||||||
| head -1
|
|
||||||
}
|
|
||||||
|
|
||||||
# ── Build issue body ────────────────────────────────────────────────────────
|
|
||||||
build_body() {
|
|
||||||
local severity_badge
|
|
||||||
if [[ "$SEVERITY" == "error" ]]; then
|
|
||||||
severity_badge="**Severity:** Error"
|
|
||||||
else
|
|
||||||
severity_badge="**Severity:** Warning"
|
|
||||||
fi
|
|
||||||
|
|
||||||
cat <<BODY
|
|
||||||
## CI Gate Failure: ${GATE}
|
|
||||||
|
|
||||||
${severity_badge}
|
|
||||||
**Workflow:** ${WORKFLOW:-unknown}
|
|
||||||
**Branch:** ${GITHUB_REF_NAME:-unknown}
|
|
||||||
**Commit:** \`${GITHUB_SHA:0:8}\`
|
|
||||||
**Run:** [View CI run](${RUN_URL})
|
|
||||||
|
|
||||||
### Details
|
|
||||||
|
|
||||||
${DETAILS}
|
|
||||||
|
|
||||||
### Resolution
|
|
||||||
|
|
||||||
Fix the issue described above and push a new commit. This issue will be closed automatically when the gate passes, or can be closed manually.
|
|
||||||
|
|
||||||
---
|
|
||||||
*Auto-created by [ci-issue-reporter](${GITEA_URL}/${REPO}/src/branch/main/automation/ci-issue-reporter.sh)*
|
|
||||||
BODY
|
|
||||||
}
|
|
||||||
|
|
||||||
# ── Build comment body (for existing issues) ────────────────────────────────
|
|
||||||
build_comment() {
|
|
||||||
cat <<COMMENT
|
|
||||||
### CI failure recurrence
|
|
||||||
|
|
||||||
**Branch:** ${GITHUB_REF_NAME:-unknown}
|
|
||||||
**Commit:** \`${GITHUB_SHA:0:8}\`
|
|
||||||
**Run:** [View CI run](${RUN_URL})
|
|
||||||
|
|
||||||
${DETAILS}
|
|
||||||
COMMENT
|
|
||||||
}
|
|
||||||
|
|
||||||
# ── Main ────────────────────────────────────────────────────────────────────
|
|
||||||
ensure_label
|
|
||||||
|
|
||||||
EXISTING=$(find_existing_issue)
|
|
||||||
|
|
||||||
if [[ -n "$EXISTING" ]]; then
|
|
||||||
# Append comment to existing issue
|
|
||||||
COMMENT_BODY=$(build_comment)
|
|
||||||
COMMENT_JSON=$(printf '%s' "$COMMENT_BODY" | python3 -c "
|
|
||||||
import sys, json
|
|
||||||
print(json.dumps({'body': sys.stdin.read()}))" 2>/dev/null)
|
|
||||||
|
|
||||||
HTTP=$(curl -sf -o /dev/null -w '%{http_code}' -X POST \
|
|
||||||
-H "Authorization: token ${GITEA_TOKEN}" \
|
|
||||||
-H "Content-Type: application/json" \
|
|
||||||
"${API}/issues/${EXISTING}/comments" \
|
|
||||||
-d "${COMMENT_JSON}" 2>/dev/null || echo "000")
|
|
||||||
|
|
||||||
if [[ "$HTTP" == "201" ]]; then
|
|
||||||
echo "Commented on existing issue #${EXISTING}"
|
|
||||||
else
|
|
||||||
echo "WARNING: Failed to comment on issue #${EXISTING} (HTTP ${HTTP})"
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
# Create new issue
|
|
||||||
ISSUE_BODY=$(build_body)
|
|
||||||
ISSUE_JSON=$(python3 -c "
|
|
||||||
import sys, json
|
|
||||||
body = sys.stdin.read()
|
|
||||||
print(json.dumps({
|
|
||||||
'title': sys.argv[1],
|
|
||||||
'body': body,
|
|
||||||
'labels': []
|
|
||||||
}))" "$TITLE" <<< "$ISSUE_BODY" 2>/dev/null)
|
|
||||||
|
|
||||||
# Create the issue
|
|
||||||
RESPONSE=$(curl -sf -X POST \
|
|
||||||
-H "Authorization: token ${GITEA_TOKEN}" \
|
|
||||||
-H "Content-Type: application/json" \
|
|
||||||
"${API}/issues" \
|
|
||||||
-d "${ISSUE_JSON}" 2>/dev/null || echo "{}")
|
|
||||||
|
|
||||||
ISSUE_NUM=$(echo "$RESPONSE" | grep -oP '"number":\s*\K[0-9]+' | head -1)
|
|
||||||
|
|
||||||
if [[ -n "$ISSUE_NUM" ]]; then
|
|
||||||
# Apply label (separate call — more reliable across Gitea versions)
|
|
||||||
LABEL_ID=$(curl -sf \
|
|
||||||
-H "Authorization: token ${GITEA_TOKEN}" \
|
|
||||||
"${API}/labels" 2>/dev/null \
|
|
||||||
| grep -oP "\"id\":\s*\K[0-9]+(?=[^}]*\"name\":\s*\"${LABEL_NAME}\")" \
|
|
||||||
| head -1 || true)
|
|
||||||
|
|
||||||
if [[ -n "$LABEL_ID" ]]; then
|
|
||||||
curl -sf -X POST \
|
|
||||||
-H "Authorization: token ${GITEA_TOKEN}" \
|
|
||||||
-H "Content-Type: application/json" \
|
|
||||||
"${API}/issues/${ISSUE_NUM}/labels" \
|
|
||||||
-d "{\"labels\":[${LABEL_ID}]}" \
|
|
||||||
> /dev/null 2>&1 || true
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "Created issue #${ISSUE_NUM}: ${TITLE}"
|
|
||||||
else
|
|
||||||
echo "WARNING: Failed to create issue"
|
|
||||||
echo "Response: ${RESPONSE}"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
@@ -230,8 +230,7 @@ class PushFiles extends CliFramework
|
|||||||
{
|
{
|
||||||
// Read platform from repo's .mokogitea/manifest.xml via API
|
// Read platform from repo's .mokogitea/manifest.xml via API
|
||||||
try {
|
try {
|
||||||
$fileInfo = $this->adapter->getFileContents($org, $repo, '.mokogitea/manifest.xml', 'main');
|
$manifestData = $this->adapter->getFileContent($org, $repo, '.mokogitea/manifest.xml', 'main');
|
||||||
$manifestData = isset($fileInfo['content']) ? base64_decode($fileInfo['content']) : '';
|
|
||||||
if (!empty($manifestData)) {
|
if (!empty($manifestData)) {
|
||||||
$xml = @simplexml_load_string($manifestData);
|
$xml = @simplexml_load_string($manifestData);
|
||||||
if ($xml !== false) {
|
if ($xml !== false) {
|
||||||
|
|||||||
+1
-20
@@ -230,31 +230,12 @@ class ReleasePackageCli extends CliFramework
|
|||||||
$subName = basename($pkgDir);
|
$subName = basename($pkgDir);
|
||||||
$subZipPath = "{$outputDir}/{$subName}.zip";
|
$subZipPath = "{$outputDir}/{$subName}.zip";
|
||||||
|
|
||||||
// If sub-package is a full repo checkout (e.g. git submodule),
|
|
||||||
// look for a src/ subdirectory containing a Joomla manifest XML
|
|
||||||
// and zip that instead of the repo root.
|
|
||||||
$subSourceDir = $pkgDir;
|
|
||||||
$srcCandidate = "{$pkgDir}/src";
|
|
||||||
if (is_dir($srcCandidate)) {
|
|
||||||
$srcManifests = array_merge(
|
|
||||||
glob("{$srcCandidate}/*.xml") ?: [],
|
|
||||||
glob("{$srcCandidate}/pkg_*.xml") ?: []
|
|
||||||
);
|
|
||||||
foreach ($srcManifests as $mf) {
|
|
||||||
if (strpos(file_get_contents($mf) ?: '', '<extension') !== false) {
|
|
||||||
$subSourceDir = $srcCandidate;
|
|
||||||
echo " Sub-package {$subName}: using src/ entry-point\n";
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
$subZip = new \ZipArchive();
|
$subZip = new \ZipArchive();
|
||||||
if ($subZip->open($subZipPath, \ZipArchive::CREATE | \ZipArchive::OVERWRITE) !== true) {
|
if ($subZip->open($subZipPath, \ZipArchive::CREATE | \ZipArchive::OVERWRITE) !== true) {
|
||||||
$this->log('ERROR', "Failed to create sub-package ZIP: {$subZipPath}");
|
$this->log('ERROR', "Failed to create sub-package ZIP: {$subZipPath}");
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
$this->addDirToZip($subZip, $subSourceDir, '', $this->excludePatterns);
|
$this->addDirToZip($subZip, $pkgDir, '', $this->excludePatterns);
|
||||||
$subZip->close();
|
$subZip->close();
|
||||||
|
|
||||||
$zip->addFile($subZipPath, "packages/{$subName}.zip");
|
$zip->addFile($subZipPath, "packages/{$subName}.zip");
|
||||||
|
|||||||
@@ -109,18 +109,10 @@ class VersionAutoBumpCli extends CliFramework
|
|||||||
echo "{$line}\n";
|
echo "{$line}\n";
|
||||||
}
|
}
|
||||||
|
|
||||||
// Step 2: Read version (--quiet suppresses banner so only the version is output)
|
// Step 2: Read version
|
||||||
$versionOutput = [];
|
$versionOutput = [];
|
||||||
exec("{$php} {$cli}/version_read.php --path " . escapeshellarg($path) . " --quiet 2>&1", $versionOutput, $versionRc);
|
exec("{$php} {$cli}/version_read.php --path " . escapeshellarg($path) . " 2>&1", $versionOutput, $versionRc);
|
||||||
// Take the last non-empty line — the version is always the final output
|
$version = trim($versionOutput[0] ?? '');
|
||||||
$version = '';
|
|
||||||
foreach (array_reverse($versionOutput) as $line) {
|
|
||||||
$line = trim($line);
|
|
||||||
if (preg_match('/^\d{2}\.\d{2}\.\d{2}/', $line)) {
|
|
||||||
$version = $line;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (empty($version)) {
|
if (empty($version)) {
|
||||||
echo "No version found — skipping\n";
|
echo "No version found — skipping\n";
|
||||||
|
|||||||
@@ -53,12 +53,6 @@ class VersionSetPlatformCli extends CliFramework
|
|||||||
// Strip any existing suffix(es) before applying the correct one
|
// Strip any existing suffix(es) before applying the correct one
|
||||||
$version = preg_replace('/(-(dev|alpha|beta|rc))+$/', '', $version);
|
$version = preg_replace('/(-(dev|alpha|beta|rc))+$/', '', $version);
|
||||||
|
|
||||||
// Validate version format — must be XX.YY.ZZ to prevent XML corruption
|
|
||||||
if (!preg_match('/^\d{2}\.\d{2}\.\d{2}$/', $version)) {
|
|
||||||
$this->log('ERROR', "Invalid version format: '{$version}' — expected XX.YY.ZZ");
|
|
||||||
return 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Append stability suffix for non-stable releases
|
// Append stability suffix for non-stable releases
|
||||||
$stabilitySuffixMap = [
|
$stabilitySuffixMap = [
|
||||||
'stable' => '',
|
'stable' => '',
|
||||||
|
|||||||
@@ -141,26 +141,6 @@ abstract class CliFramework
|
|||||||
/** @var float Script start time for elapsed-time reporting. */
|
/** @var float Script start time for elapsed-time reporting. */
|
||||||
private float $startTime;
|
private float $startTime;
|
||||||
|
|
||||||
// =========================================================================
|
|
||||||
// Display output — all decorative output goes to stderr
|
|
||||||
// =========================================================================
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Write decorative/diagnostic output to stderr.
|
|
||||||
*
|
|
||||||
* All non-data output (banners, progress bars, section headers, status
|
|
||||||
* lines, log messages) MUST use this method so that stdout is reserved
|
|
||||||
* for machine-readable data. This ensures that shell captures like
|
|
||||||
* VERSION=$(php version_read.php --path .)
|
|
||||||
* only receive the actual data, not decorative text.
|
|
||||||
*
|
|
||||||
* @since 04.00.16
|
|
||||||
*/
|
|
||||||
protected function display(string $text): void
|
|
||||||
{
|
|
||||||
fwrite(STDERR, $text);
|
|
||||||
}
|
|
||||||
|
|
||||||
// =========================================================================
|
// =========================================================================
|
||||||
// Constructor
|
// Constructor
|
||||||
// =========================================================================
|
// =========================================================================
|
||||||
@@ -346,14 +326,14 @@ abstract class CliFramework
|
|||||||
protected function printHelp(): void
|
protected function printHelp(): void
|
||||||
{
|
{
|
||||||
$w = $this->termWidth();
|
$w = $this->termWidth();
|
||||||
$this->display($this->c(self::C_BOLD . self::C_CYAN, $this->scriptName));
|
echo $this->c(self::C_BOLD . self::C_CYAN, $this->scriptName);
|
||||||
if ($this->description !== '') {
|
if ($this->description !== '') {
|
||||||
$this->display(' — ' . $this->description);
|
echo ' — ' . $this->description;
|
||||||
}
|
}
|
||||||
$this->display("\n");
|
echo "\n";
|
||||||
$this->display($this->c(self::C_DIM, str_repeat(self::BOX_H, $w)) . "\n\n");
|
echo $this->c(self::C_DIM, str_repeat(self::BOX_H, $w)) . "\n\n";
|
||||||
$this->display($this->c(self::C_BOLD, 'Usage:') . " php {$this->scriptName}.php [options]\n\n");
|
echo $this->c(self::C_BOLD, 'Usage:') . " php {$this->scriptName}.php [options]\n\n";
|
||||||
$this->display($this->c(self::C_BOLD, 'Options:') . "\n");
|
echo $this->c(self::C_BOLD, 'Options:') . "\n";
|
||||||
|
|
||||||
$builtIn = [
|
$builtIn = [
|
||||||
'--help' => ['desc' => 'Show this help message', 'default' => null],
|
'--help' => ['desc' => 'Show this help message', 'default' => null],
|
||||||
@@ -368,16 +348,16 @@ abstract class CliFramework
|
|||||||
$hint = ($default !== null && $default !== false)
|
$hint = ($default !== null && $default !== false)
|
||||||
? $this->c(self::C_DIM, " (default: {$default})")
|
? $this->c(self::C_DIM, " (default: {$default})")
|
||||||
: '';
|
: '';
|
||||||
$this->display(sprintf(
|
printf(
|
||||||
" %s%-22s%s%s%s\n",
|
" %s%-22s%s%s%s\n",
|
||||||
self::C_CYAN,
|
self::C_CYAN,
|
||||||
$name,
|
$name,
|
||||||
self::C_RESET,
|
self::C_RESET,
|
||||||
$def['desc'],
|
$def['desc'],
|
||||||
$hint
|
$hint
|
||||||
));
|
);
|
||||||
}
|
}
|
||||||
$this->display("\n");
|
echo "\n";
|
||||||
}
|
}
|
||||||
|
|
||||||
// =========================================================================
|
// =========================================================================
|
||||||
@@ -398,23 +378,23 @@ abstract class CliFramework
|
|||||||
$titleLine = $this->padRight($titleStyled, $inner, strlen($titleRaw));
|
$titleLine = $this->padRight($titleStyled, $inner, strlen($titleRaw));
|
||||||
$descLine = ($desc !== '') ? $this->padRight(" {$desc}", $inner) : null;
|
$descLine = ($desc !== '') ? $this->padRight(" {$desc}", $inner) : null;
|
||||||
|
|
||||||
$this->display("\n");
|
echo "\n";
|
||||||
$this->display($this->c(
|
echo $this->c(
|
||||||
self::C_CYAN,
|
self::C_CYAN,
|
||||||
self::BOX_TL . str_repeat(self::BOX_H, $inner) . self::BOX_TR
|
self::BOX_TL . str_repeat(self::BOX_H, $inner) . self::BOX_TR
|
||||||
) . "\n");
|
) . "\n";
|
||||||
$this->display($this->c(self::C_CYAN, self::BOX_V)
|
echo $this->c(self::C_CYAN, self::BOX_V)
|
||||||
. $this->c(self::C_BOLD, $titleLine)
|
. $this->c(self::C_BOLD, $titleLine)
|
||||||
. $this->c(self::C_CYAN, self::BOX_V) . "\n");
|
. $this->c(self::C_CYAN, self::BOX_V) . "\n";
|
||||||
if ($descLine !== null) {
|
if ($descLine !== null) {
|
||||||
$this->display($this->c(self::C_CYAN, self::BOX_V)
|
echo $this->c(self::C_CYAN, self::BOX_V)
|
||||||
. $this->c(self::C_DIM, $descLine)
|
. $this->c(self::C_DIM, $descLine)
|
||||||
. $this->c(self::C_CYAN, self::BOX_V) . "\n");
|
. $this->c(self::C_CYAN, self::BOX_V) . "\n";
|
||||||
}
|
}
|
||||||
$this->display($this->c(
|
echo $this->c(
|
||||||
self::C_CYAN,
|
self::C_CYAN,
|
||||||
self::BOX_BL . str_repeat(self::BOX_H, $inner) . self::BOX_BR
|
self::BOX_BL . str_repeat(self::BOX_H, $inner) . self::BOX_BR
|
||||||
) . "\n\n");
|
) . "\n\n";
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Print the dry-run notice box. */
|
/** Print the dry-run notice box. */
|
||||||
@@ -423,18 +403,18 @@ abstract class CliFramework
|
|||||||
$w = min($this->termWidth(), 70);
|
$w = min($this->termWidth(), 70);
|
||||||
$msg = ' ' . self::ICON_DRY . ' DRY-RUN MODE — no changes will be written ';
|
$msg = ' ' . self::ICON_DRY . ' DRY-RUN MODE — no changes will be written ';
|
||||||
$row = $this->padRight($msg, $w - 2);
|
$row = $this->padRight($msg, $w - 2);
|
||||||
$this->display($this->c(
|
echo $this->c(
|
||||||
self::C_YELLOW . self::C_BOLD,
|
self::C_YELLOW . self::C_BOLD,
|
||||||
self::BOX_TL . str_repeat(self::BOX_H, $w - 2) . self::BOX_TR
|
self::BOX_TL . str_repeat(self::BOX_H, $w - 2) . self::BOX_TR
|
||||||
) . "\n");
|
) . "\n";
|
||||||
$this->display($this->c(
|
echo $this->c(
|
||||||
self::C_YELLOW . self::C_BOLD,
|
self::C_YELLOW . self::C_BOLD,
|
||||||
self::BOX_V . $row . self::BOX_V
|
self::BOX_V . $row . self::BOX_V
|
||||||
) . "\n");
|
) . "\n";
|
||||||
$this->display($this->c(
|
echo $this->c(
|
||||||
self::C_YELLOW . self::C_BOLD,
|
self::C_YELLOW . self::C_BOLD,
|
||||||
self::BOX_BL . str_repeat(self::BOX_H, $w - 2) . self::BOX_BR
|
self::BOX_BL . str_repeat(self::BOX_H, $w - 2) . self::BOX_BR
|
||||||
) . "\n\n");
|
) . "\n\n";
|
||||||
}
|
}
|
||||||
|
|
||||||
// =========================================================================
|
// =========================================================================
|
||||||
@@ -455,11 +435,11 @@ abstract class CliFramework
|
|||||||
$w = $this->termWidth();
|
$w = $this->termWidth();
|
||||||
$text = " {$title} ";
|
$text = " {$title} ";
|
||||||
$fill = max(0, $w - strlen($text) - 4);
|
$fill = max(0, $w - strlen($text) - 4);
|
||||||
$this->display("\n");
|
echo "\n";
|
||||||
$this->display($this->c(
|
echo $this->c(
|
||||||
self::C_CYAN,
|
self::C_CYAN,
|
||||||
str_repeat(self::BOX_H, 2) . $text . str_repeat(self::BOX_H, $fill)
|
str_repeat(self::BOX_H, 2) . $text . str_repeat(self::BOX_H, $fill)
|
||||||
) . "\n\n");
|
) . "\n\n";
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Print a plain horizontal divider. */
|
/** Print a plain horizontal divider. */
|
||||||
@@ -469,7 +449,7 @@ abstract class CliFramework
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
$this->clearProgress();
|
$this->clearProgress();
|
||||||
$this->display($this->c(self::C_DIM, str_repeat(self::BOX_H, $this->termWidth())) . "\n");
|
echo $this->c(self::C_DIM, str_repeat(self::BOX_H, $this->termWidth())) . "\n";
|
||||||
}
|
}
|
||||||
|
|
||||||
// =========================================================================
|
// =========================================================================
|
||||||
@@ -515,7 +495,11 @@ abstract class CliFramework
|
|||||||
|
|
||||||
$line = "{$ts} {$icon} {$badge} {$text}\n";
|
$line = "{$ts} {$icon} {$badge} {$text}\n";
|
||||||
|
|
||||||
$this->display($line);
|
if ($level === 'ERROR') {
|
||||||
|
fwrite(STDERR, $line);
|
||||||
|
} else {
|
||||||
|
echo $line;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Log a success message. */
|
/** Log a success message. */
|
||||||
@@ -580,7 +564,7 @@ abstract class CliFramework
|
|||||||
? ' ' . $this->c(self::C_DIM, "— {$detail}")
|
? ' ' . $this->c(self::C_DIM, "— {$detail}")
|
||||||
: '';
|
: '';
|
||||||
|
|
||||||
$this->display(' ' . $this->c($color . self::C_BOLD, $icon) . ' ' . $label . $suffix . "\n");
|
echo ' ' . $this->c($color . self::C_BOLD, $icon) . ' ' . $label . $suffix . "\n";
|
||||||
}
|
}
|
||||||
|
|
||||||
// =========================================================================
|
// =========================================================================
|
||||||
@@ -617,10 +601,10 @@ abstract class CliFramework
|
|||||||
$line = " [{$bar}] {$percent} {$counter}{$suffix}";
|
$line = " [{$bar}] {$percent} {$counter}{$suffix}";
|
||||||
|
|
||||||
if ($newline) {
|
if ($newline) {
|
||||||
$this->display("\r{$line}\n");
|
echo "\r{$line}\n";
|
||||||
$this->progressActive = false;
|
$this->progressActive = false;
|
||||||
} else {
|
} else {
|
||||||
$this->display("\r{$line}");
|
echo "\r{$line}";
|
||||||
$this->progressActive = true;
|
$this->progressActive = true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -629,7 +613,7 @@ abstract class CliFramework
|
|||||||
protected function clearProgress(): void
|
protected function clearProgress(): void
|
||||||
{
|
{
|
||||||
if ($this->progressActive) {
|
if ($this->progressActive) {
|
||||||
$this->display("\r" . str_repeat(' ', $this->termWidth()) . "\r");
|
echo "\r" . str_repeat(' ', $this->termWidth()) . "\r";
|
||||||
$this->progressActive = false;
|
$this->progressActive = false;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -660,8 +644,8 @@ abstract class CliFramework
|
|||||||
$maxKey = max(array_map('strlen', array_keys($rows)));
|
$maxKey = max(array_map('strlen', array_keys($rows)));
|
||||||
$inner = $maxKey + 20;
|
$inner = $maxKey + 20;
|
||||||
|
|
||||||
$this->display("\n");
|
echo "\n";
|
||||||
$this->display($this->c($color, self::BOX_TL . str_repeat(self::BOX_H, $inner) . self::BOX_TR) . "\n");
|
echo $this->c($color, self::BOX_TL . str_repeat(self::BOX_H, $inner) . self::BOX_TR) . "\n";
|
||||||
|
|
||||||
foreach ($rows as $label => $value) {
|
foreach ($rows as $label => $value) {
|
||||||
$valStr = (string) $value;
|
$valStr = (string) $value;
|
||||||
@@ -669,10 +653,10 @@ abstract class CliFramework
|
|||||||
$padding = $inner - strlen($label) - $valVis - 4;
|
$padding = $inner - strlen($label) - $valVis - 4;
|
||||||
$row = ' ' . $this->c(self::C_BOLD, $label)
|
$row = ' ' . $this->c(self::C_BOLD, $label)
|
||||||
. str_repeat(' ', max(1, $padding)) . $valStr . ' ';
|
. str_repeat(' ', max(1, $padding)) . $valStr . ' ';
|
||||||
$this->display($this->c($color, self::BOX_V) . $row . $this->c($color, self::BOX_V) . "\n");
|
echo $this->c($color, self::BOX_V) . $row . $this->c($color, self::BOX_V) . "\n";
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->display($this->c($color, self::BOX_BL . str_repeat(self::BOX_H, $inner) . self::BOX_BR) . "\n\n");
|
echo $this->c($color, self::BOX_BL . str_repeat(self::BOX_H, $inner) . self::BOX_BR) . "\n\n";
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -718,7 +702,7 @@ abstract class CliFramework
|
|||||||
$this->clearProgress();
|
$this->clearProgress();
|
||||||
$badge = $this->c(self::C_BOLD . self::C_MAGENTA, "Step {$current}/{$total}");
|
$badge = $this->c(self::C_BOLD . self::C_MAGENTA, "Step {$current}/{$total}");
|
||||||
$arrow = $this->c(self::C_DIM, self::ICON_INFO);
|
$arrow = $this->c(self::C_DIM, self::ICON_INFO);
|
||||||
$this->display("\n{$badge} {$arrow} {$title}\n");
|
echo "\n{$badge} {$arrow} {$title}\n";
|
||||||
}
|
}
|
||||||
|
|
||||||
// =========================================================================
|
// =========================================================================
|
||||||
@@ -980,13 +964,13 @@ abstract class CliFramework
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Header.
|
// Header.
|
||||||
$this->display($sep . "\n");
|
echo $sep . "\n";
|
||||||
$headerLine = '|';
|
$headerLine = '|';
|
||||||
foreach ($headers as $i => $h) {
|
foreach ($headers as $i => $h) {
|
||||||
$headerLine .= ' ' . $this->c(self::C_BOLD, str_pad($h, $widths[$i])) . ' |';
|
$headerLine .= ' ' . $this->c(self::C_BOLD, str_pad($h, $widths[$i])) . ' |';
|
||||||
}
|
}
|
||||||
$this->display($headerLine . "\n");
|
echo $headerLine . "\n";
|
||||||
$this->display($sep . "\n");
|
echo $sep . "\n";
|
||||||
|
|
||||||
// Rows.
|
// Rows.
|
||||||
foreach ($rows as $row) {
|
foreach ($rows as $row) {
|
||||||
@@ -994,9 +978,9 @@ abstract class CliFramework
|
|||||||
foreach ($row as $i => $cell) {
|
foreach ($row as $i => $cell) {
|
||||||
$line .= ' ' . str_pad((string) $cell, $widths[$i]) . ' |';
|
$line .= ' ' . str_pad((string) $cell, $widths[$i]) . ' |';
|
||||||
}
|
}
|
||||||
$this->display($line . "\n");
|
echo $line . "\n";
|
||||||
}
|
}
|
||||||
$this->display($sep . "\n");
|
echo $sep . "\n";
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,117 @@
|
|||||||
|
<!--
|
||||||
|
Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
|
||||||
|
|
||||||
|
This file is part of a Moko Consulting project.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
|
||||||
|
# FILE INFORMATION
|
||||||
|
DEFGROUP: MokoPlatform.Documentation
|
||||||
|
INGROUP: MokoPlatform.Templates
|
||||||
|
REPO: https://git.mokoconsulting.tech/MokoConsulting/moko-platform
|
||||||
|
PATH: /templates/docs/dolibarr/update-server.md
|
||||||
|
BRIEF: Developer guide for wiring up Dolibarr module update checks — synced to docs/ in all CRM repos
|
||||||
|
-->
|
||||||
|
|
||||||
|
# Module Update Server
|
||||||
|
|
||||||
|
This module uses `update.txt` hosted in the repo root to enable Dolibarr's built-in update checker.
|
||||||
|
|
||||||
|
## How It Works
|
||||||
|
|
||||||
|
1. When a PR is merged to `main`, the `auto-release.yml` workflow:
|
||||||
|
- Reads the version from `README.md`
|
||||||
|
- Sets `$this->version` in the module descriptor to the real version
|
||||||
|
- Creates a GitHub Release with a git tag
|
||||||
|
- Writes `update.txt` to the repo root
|
||||||
|
2. The module descriptor's `$this->url_last_version` points to the raw `update.txt` URL
|
||||||
|
3. Dolibarr's admin panel fetches this URL to check for available updates
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
### 1. Module Descriptor
|
||||||
|
|
||||||
|
In `src/core/modules/mod*.class.php`, ensure these lines are in the constructor:
|
||||||
|
|
||||||
|
```php
|
||||||
|
// Version — 'development' on dev branches, real version set by auto-release on merge to main
|
||||||
|
$this->version = 'development';
|
||||||
|
|
||||||
|
// Update check — points to update.txt written by auto-release workflow
|
||||||
|
$this->url_last_version = 'https://raw.githubusercontent.com/mokoconsulting-tech/REPO_NAME/main/update.txt';
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace `REPO_NAME` with this repository's name.
|
||||||
|
|
||||||
|
### 2. Version Parser
|
||||||
|
|
||||||
|
Add this method to the module descriptor class to parse the JSON response:
|
||||||
|
|
||||||
|
```php
|
||||||
|
/**
|
||||||
|
* Get the latest available version from the update server.
|
||||||
|
*
|
||||||
|
* Reads update.txt from the GitHub repo and extracts the version field.
|
||||||
|
* Called by Dolibarr's module update checker.
|
||||||
|
*
|
||||||
|
* @return string Latest version number, or empty string on failure
|
||||||
|
*/
|
||||||
|
public function getLatestVersion(): string
|
||||||
|
{
|
||||||
|
if (empty($this->url_last_version)) {
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
|
||||||
|
$content = @file_get_contents($this->url_last_version);
|
||||||
|
if ($content === false) {
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
|
||||||
|
$data = json_decode($content, true);
|
||||||
|
return $data['version'] ?? '';
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. That's It
|
||||||
|
|
||||||
|
Everything else is automated:
|
||||||
|
- `deploy-dev.yml` sets version to `"development"` on dev branches
|
||||||
|
- `auto-release.yml` sets the real version and writes `update.txt` on release
|
||||||
|
- `sync-version-on-merge.yml` bumps the patch version in README.md
|
||||||
|
|
||||||
|
## update.txt Format
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"version": "01.02.03",
|
||||||
|
"tag": "v01.02.03",
|
||||||
|
"repo": "mokoconsulting-tech/REPO_NAME",
|
||||||
|
"release_url": "https://git.mokoconsulting.tech/mokoconsulting-tech/REPO_NAME/releases/tag/v01.02.03",
|
||||||
|
"updated": "2026-03-27T00:00:00Z"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
> **Do not edit `update.txt` manually** — it is auto-generated by the release workflow.
|
||||||
|
|
||||||
|
## Version Lifecycle
|
||||||
|
|
||||||
|
```
|
||||||
|
dev/** branch → $this->version = "development" (no update.txt)
|
||||||
|
merge to main → $this->version = "01.02.03" → update.txt written → GitHub Release
|
||||||
|
next commit → README auto-bumps to 01.02.04 (no release yet)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
| Issue | Solution |
|
||||||
|
|-------|----------|
|
||||||
|
| `update.txt` doesn't exist | Merge a PR to main — the first release creates it |
|
||||||
|
| Version shows "development" | Expected on `dev/**` branches — real version set on release |
|
||||||
|
| Dolibarr doesn't detect updates | Check `$this->url_last_version` URL returns valid JSON |
|
||||||
|
| Wrong version in update.txt | Check README.md VERSION field — it's the source of truth |
|
||||||
|
|
||||||
|
### Test the URL
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -s https://raw.githubusercontent.com/mokoconsulting-tech/REPO_NAME/main/update.txt | jq .
|
||||||
|
```
|
||||||
@@ -0,0 +1,70 @@
|
|||||||
|
<!--
|
||||||
|
Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
|
||||||
|
|
||||||
|
This file is part of a Moko Consulting project.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
|
||||||
|
# FILE INFORMATION
|
||||||
|
DEFGROUP: {{REPO_NAME}}.Documentation
|
||||||
|
INGROUP: MokoPlatform.Templates
|
||||||
|
REPO: https://git.mokoconsulting.tech/mokoconsulting-tech/{{REPO_NAME}}
|
||||||
|
PATH: /docs/update-server.md
|
||||||
|
VERSION: {{standards_version}}
|
||||||
|
BRIEF: How this module's update server file (update.txt) is managed
|
||||||
|
-->
|
||||||
|
|
||||||
|
# Dolibarr Update Server
|
||||||
|
|
||||||
|
[](https://git.mokoconsulting.tech/MokoConsulting/moko-platform)
|
||||||
|
|
||||||
|
This document explains how `update.txt` is automatically managed for this Dolibarr module.
|
||||||
|
|
||||||
|
## How It Works
|
||||||
|
|
||||||
|
Dolibarr checks for module updates by fetching a plain-text file from the URL in `$this->url_last_version` in the module descriptor (`src/core/modules/mod*.class.php`). The file must contain **only the version string** — no JSON, no XML, no trailing newline.
|
||||||
|
|
||||||
|
### Automatic Generation
|
||||||
|
|
||||||
|
| Event | Workflow | `update.txt` Content | `$this->version` |
|
||||||
|
|-------|----------|---------------------|-------------------|
|
||||||
|
| Merge to `main` | `auto-release.yml` | `XX.YY.ZZ` (real version) | Real version |
|
||||||
|
| Push to `dev/**` | `deploy-dev.yml` | `development` | `development` |
|
||||||
|
| Push to `rc/**` | `deploy-dev.yml` | `XX.YY.ZZ-rc` | RC version |
|
||||||
|
|
||||||
|
### Module Descriptor
|
||||||
|
|
||||||
|
The `url_last_version` in your module descriptor should point to:
|
||||||
|
|
||||||
|
```
|
||||||
|
https://raw.githubusercontent.com/mokoconsulting-tech/{{REPO_NAME}}/main/update.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
This is set automatically by `version_set_platform.php` during the build pipeline. **Never manually edit `$this->version` or `$this->url_last_version`** — the workflows handle it.
|
||||||
|
|
||||||
|
### Branch Lifecycle
|
||||||
|
|
||||||
|
```
|
||||||
|
dev/XX.YY.ZZ → rc/XX.YY.ZZ → main → version/XX
|
||||||
|
(development) (release candidate) (stable release) (frozen snapshot)
|
||||||
|
```
|
||||||
|
|
||||||
|
1. **Development** (`dev/**`): `update.txt` = `development`, `$this->version` = `development`
|
||||||
|
2. **Release Candidate** (`rc/**`): `update.txt` = `XX.YY.ZZ-rc`, version set to RC
|
||||||
|
3. **Stable Release** (merge to `main`): `auto-release.yml` writes real version to `update.txt`, creates GitHub Release + tag, creates `version/XX` branch
|
||||||
|
4. **Frozen Snapshot** (`version/XX`): immutable, never force-pushed
|
||||||
|
|
||||||
|
### Health Checks
|
||||||
|
|
||||||
|
The `repo_health.yml` workflow verifies on every commit:
|
||||||
|
|
||||||
|
- `update.txt` exists in the repository root
|
||||||
|
- Module descriptor (`mod*.class.php`) exists in `src/core/modules/`
|
||||||
|
- `$this->numero` is set and non-zero
|
||||||
|
- `$this->version` is not hardcoded (should be set by workflow)
|
||||||
|
- `url_last_version` points to `update.txt` (not `update.json`)
|
||||||
|
- `url_last_version` references `/main/` branch on the main branch
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*Managed by [moko-platform](https://git.mokoconsulting.tech/MokoConsulting/moko-platform). See [docs/workflows/update-server.md](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/blob/main/docs/workflows/update-server.md) for the full specification.*
|
||||||
@@ -0,0 +1,122 @@
|
|||||||
|
<!--
|
||||||
|
Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
|
||||||
|
|
||||||
|
This file is part of a Moko Consulting project.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
|
||||||
|
# FILE INFORMATION
|
||||||
|
DEFGROUP: {{REPO_NAME}}.Documentation
|
||||||
|
INGROUP: MokoPlatform.Templates
|
||||||
|
REPO: https://git.mokoconsulting.tech/mokoconsulting-tech/{{REPO_NAME}}
|
||||||
|
PATH: /docs/update-server.md
|
||||||
|
VERSION: {{standards_version}}
|
||||||
|
BRIEF: How this extension's Joomla update server file (updates.xml) is managed
|
||||||
|
-->
|
||||||
|
|
||||||
|
# Joomla Update Server
|
||||||
|
|
||||||
|
[](https://git.mokoconsulting.tech/MokoConsulting/moko-platform)
|
||||||
|
|
||||||
|
This document explains how `updates.xml` is automatically managed for this Joomla extension following the [Joomla Update Server specification](https://docs.joomla.org/Deploying_an_Update_Server).
|
||||||
|
|
||||||
|
## How It Works
|
||||||
|
|
||||||
|
Joomla checks for extension updates by fetching an XML file from the URL defined in the `<updateservers>` tag in the extension's XML manifest. moko-platform generates this file automatically.
|
||||||
|
|
||||||
|
### Automatic Generation
|
||||||
|
|
||||||
|
| Event | Workflow | `<tag>` | `<version>` |
|
||||||
|
|-------|----------|---------|-------------|
|
||||||
|
| Merge to `main` | `auto-release.yml` | `stable` | `XX.YY.ZZ` |
|
||||||
|
| Push to `dev/**` | `deploy-dev.yml` | `development` | `development` |
|
||||||
|
| Push to `rc/**` | `deploy-dev.yml` | `rc` | `XX.YY.ZZ-rc` |
|
||||||
|
|
||||||
|
### Generated XML Structure
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<updates>
|
||||||
|
<update>
|
||||||
|
<name>Extension Name</name>
|
||||||
|
<description>Extension Name update</description>
|
||||||
|
<element>com_extensionname</element>
|
||||||
|
<type>component</type>
|
||||||
|
<version>01.02.03</version>
|
||||||
|
<client>site</client>
|
||||||
|
<folder>system</folder> <!-- plugins only -->
|
||||||
|
<tags>
|
||||||
|
<tag>stable</tag>
|
||||||
|
</tags>
|
||||||
|
<downloads>
|
||||||
|
<downloadurl type="full" format="zip">https://git.mokoconsulting.tech/.../releases/download/v01.02.03/com_ext-01.02.03.zip</downloadurl>
|
||||||
|
<downloadurl type="full" format="zip">https://github.com/.../releases/download/v01.02.03/com_ext-01.02.03.zip</downloadurl>
|
||||||
|
</downloads>
|
||||||
|
<targetplatform name="joomla" version="((5\.[0-9])|(6\.[0-9]))" />
|
||||||
|
<php_minimum>8.2</php_minimum> <!-- if present in manifest -->
|
||||||
|
<maintainer>Moko Consulting</maintainer>
|
||||||
|
<maintainerurl>https://mokoconsulting.tech</maintainerurl>
|
||||||
|
</update>
|
||||||
|
</updates>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Metadata Source
|
||||||
|
|
||||||
|
All metadata is extracted from the extension's XML manifest (`src/*.xml`) at build time:
|
||||||
|
|
||||||
|
| XML Element | Source | Notes |
|
||||||
|
|-------------|--------|-------|
|
||||||
|
| `<name>` | `<name>` in manifest | Extension display name |
|
||||||
|
| `<element>` | `<element>` in manifest | Must match installed extension identifier |
|
||||||
|
| `<type>` | `type` attribute on `<extension>` | `component`, `module`, `plugin`, `library`, `package`, `template` |
|
||||||
|
| `<client>` | `client` attribute on `<extension>` | `site` or `administrator` — **required for plugins and modules** |
|
||||||
|
| `<folder>` | `group` attribute on `<extension>` | Plugin group (e.g., `system`, `content`) — **required for plugins** |
|
||||||
|
| `<targetplatform>` | `<targetplatform>` in manifest | Falls back to Joomla 5.x / 6.x if not specified |
|
||||||
|
| `<php_minimum>` | `<php_minimum>` in manifest | Included only if present |
|
||||||
|
|
||||||
|
### Extension Manifest Setup
|
||||||
|
|
||||||
|
Your XML manifest must include an `<updateservers>` tag pointing to the `updates.xml` on the `main` branch:
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<extension type="component" client="site" method="upgrade">
|
||||||
|
<name>My Extension</name>
|
||||||
|
<element>com_myextension</element>
|
||||||
|
<!-- ... -->
|
||||||
|
<updateservers>
|
||||||
|
<server type="extension" priority="1" name="My Extension Update Server (Gitea)">
|
||||||
|
https://git.mokoconsulting.tech/mokoconsulting-tech/{{REPO_NAME}}/raw/branch/main/updates.xml
|
||||||
|
</server>
|
||||||
|
<server type="extension" priority="2" name="My Extension Update Server (GitHub)">
|
||||||
|
https://raw.githubusercontent.com/mokoconsulting-tech/{{REPO_NAME}}/main/updates.xml
|
||||||
|
</server>
|
||||||
|
</updateservers>
|
||||||
|
</extension>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Branch Lifecycle
|
||||||
|
|
||||||
|
```
|
||||||
|
dev/XX.YY.ZZ → rc/XX.YY.ZZ → main → version/XX
|
||||||
|
(development) (rc) (stable) (frozen snapshot)
|
||||||
|
```
|
||||||
|
|
||||||
|
1. **Development** (`dev/**`): `updates.xml` with `<tag>development</tag>`, download points to branch archive
|
||||||
|
2. **Release Candidate** (`rc/**`): `updates.xml` with `<tag>rc</tag>`, version set to `XX.YY.ZZ-rc`
|
||||||
|
3. **Stable Release** (merge to `main`): `updates.xml` with `<tag>stable</tag>`, download points to Gitea Release asset (primary) + GitHub Release asset (mirror)
|
||||||
|
4. **Frozen Snapshot** (`version/XX`): immutable, never force-pushed
|
||||||
|
|
||||||
|
### Health Checks
|
||||||
|
|
||||||
|
The `repo_health.yml` workflow verifies on every commit:
|
||||||
|
|
||||||
|
- `updates.xml` exists in the repository root
|
||||||
|
- XML manifest exists with `<extension>` tag
|
||||||
|
- `<version>`, `<name>`, `<author>`, `<namespace>` tags present
|
||||||
|
- Extension `type` attribute is valid
|
||||||
|
- Language `.ini` files exist
|
||||||
|
- `index.html` directory listing protection in `src/`, `src/admin/`, `src/site/`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*Managed by [moko-platform](https://git.mokoconsulting.tech/MokoConsulting/moko-platform). See [docs/workflows/update-server.md](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/blob/main/docs/workflows/update-server.md) for the full specification.*
|
||||||
@@ -0,0 +1,119 @@
|
|||||||
|
<?xml version='1.0' encoding='UTF-8'?>
|
||||||
|
<!-- Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
|
||||||
|
SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
VERSION: {{VERSION}}
|
||||||
|
-->
|
||||||
|
|
||||||
|
<updates>
|
||||||
|
|
||||||
|
<!-- 1. DEVELOPMENT -->
|
||||||
|
<update>
|
||||||
|
<name>{{EXTENSION_NAME}}</name>
|
||||||
|
<description>{{EXTENSION_NAME}} development build — unstable.</description>
|
||||||
|
<element>{{EXTENSION_ELEMENT}}</element>
|
||||||
|
<type>{{EXTENSION_TYPE}}</type>
|
||||||
|
<folder>{{EXTENSION_FOLDER}}</folder>
|
||||||
|
<client>{{EXTENSION_CLIENT}}</client>
|
||||||
|
<version>{{VERSION}}</version>
|
||||||
|
<creationDate>{{DATE}}</creationDate>
|
||||||
|
<infourl title='{{EXTENSION_NAME}} Dev'>https://git.mokoconsulting.tech/MokoConsulting/{{REPO_NAME}}/releases/tag/development</infourl>
|
||||||
|
<downloads>
|
||||||
|
<downloadurl type='full' format='zip'>https://git.mokoconsulting.tech/MokoConsulting/{{REPO_NAME}}/releases/download/development/{{EXTENSION_ELEMENT}}-{{VERSION}}-dev.zip</downloadurl>
|
||||||
|
</downloads>
|
||||||
|
<sha256></sha256>
|
||||||
|
<tags><tag>development</tag></tags>
|
||||||
|
<maintainer>Moko Consulting</maintainer>
|
||||||
|
<maintainerurl>https://mokoconsulting.tech</maintainerurl>
|
||||||
|
<targetplatform name='joomla' version='(5|6).*'/>
|
||||||
|
<php_minimum>8.1</php_minimum>
|
||||||
|
</update>
|
||||||
|
|
||||||
|
<!-- 2. ALPHA -->
|
||||||
|
<update>
|
||||||
|
<name>{{EXTENSION_NAME}}</name>
|
||||||
|
<description>{{EXTENSION_NAME}} alpha build — early testing.</description>
|
||||||
|
<element>{{EXTENSION_ELEMENT}}</element>
|
||||||
|
<type>{{EXTENSION_TYPE}}</type>
|
||||||
|
<folder>{{EXTENSION_FOLDER}}</folder>
|
||||||
|
<client>{{EXTENSION_CLIENT}}</client>
|
||||||
|
<version>{{VERSION}}</version>
|
||||||
|
<creationDate>{{DATE}}</creationDate>
|
||||||
|
<infourl title='{{EXTENSION_NAME}} Alpha'>https://git.mokoconsulting.tech/MokoConsulting/{{REPO_NAME}}/releases/tag/alpha</infourl>
|
||||||
|
<downloads>
|
||||||
|
<downloadurl type='full' format='zip'>https://git.mokoconsulting.tech/MokoConsulting/{{REPO_NAME}}/releases/download/alpha/{{EXTENSION_ELEMENT}}-{{VERSION}}-alpha.zip</downloadurl>
|
||||||
|
</downloads>
|
||||||
|
<sha256></sha256>
|
||||||
|
<tags><tag>alpha</tag></tags>
|
||||||
|
<maintainer>Moko Consulting</maintainer>
|
||||||
|
<maintainerurl>https://mokoconsulting.tech</maintainerurl>
|
||||||
|
<targetplatform name='joomla' version='(5|6).*'/>
|
||||||
|
<php_minimum>8.1</php_minimum>
|
||||||
|
</update>
|
||||||
|
|
||||||
|
<!-- 3. BETA -->
|
||||||
|
<update>
|
||||||
|
<name>{{EXTENSION_NAME}}</name>
|
||||||
|
<description>{{EXTENSION_NAME}} beta build — feature complete, stability testing.</description>
|
||||||
|
<element>{{EXTENSION_ELEMENT}}</element>
|
||||||
|
<type>{{EXTENSION_TYPE}}</type>
|
||||||
|
<folder>{{EXTENSION_FOLDER}}</folder>
|
||||||
|
<client>{{EXTENSION_CLIENT}}</client>
|
||||||
|
<version>{{VERSION}}</version>
|
||||||
|
<creationDate>{{DATE}}</creationDate>
|
||||||
|
<infourl title='{{EXTENSION_NAME}} Beta'>https://git.mokoconsulting.tech/MokoConsulting/{{REPO_NAME}}/releases/tag/beta</infourl>
|
||||||
|
<downloads>
|
||||||
|
<downloadurl type='full' format='zip'>https://git.mokoconsulting.tech/MokoConsulting/{{REPO_NAME}}/releases/download/beta/{{EXTENSION_ELEMENT}}-{{VERSION}}-beta.zip</downloadurl>
|
||||||
|
</downloads>
|
||||||
|
<sha256></sha256>
|
||||||
|
<tags><tag>beta</tag></tags>
|
||||||
|
<maintainer>Moko Consulting</maintainer>
|
||||||
|
<maintainerurl>https://mokoconsulting.tech</maintainerurl>
|
||||||
|
<targetplatform name='joomla' version='(5|6).*'/>
|
||||||
|
<php_minimum>8.1</php_minimum>
|
||||||
|
</update>
|
||||||
|
|
||||||
|
<!-- 4. RC -->
|
||||||
|
<update>
|
||||||
|
<name>{{EXTENSION_NAME}}</name>
|
||||||
|
<description>{{EXTENSION_NAME}} release candidate — testing only.</description>
|
||||||
|
<element>{{EXTENSION_ELEMENT}}</element>
|
||||||
|
<type>{{EXTENSION_TYPE}}</type>
|
||||||
|
<folder>{{EXTENSION_FOLDER}}</folder>
|
||||||
|
<client>{{EXTENSION_CLIENT}}</client>
|
||||||
|
<version>{{VERSION}}</version>
|
||||||
|
<creationDate>{{DATE}}</creationDate>
|
||||||
|
<infourl title='{{EXTENSION_NAME}} RC'>https://git.mokoconsulting.tech/MokoConsulting/{{REPO_NAME}}/releases/tag/release-candidate</infourl>
|
||||||
|
<downloads>
|
||||||
|
<downloadurl type='full' format='zip'>https://git.mokoconsulting.tech/MokoConsulting/{{REPO_NAME}}/releases/download/release-candidate/{{EXTENSION_ELEMENT}}-{{VERSION}}-rc.zip</downloadurl>
|
||||||
|
</downloads>
|
||||||
|
<sha256></sha256>
|
||||||
|
<tags><tag>rc</tag></tags>
|
||||||
|
<maintainer>Moko Consulting</maintainer>
|
||||||
|
<maintainerurl>https://mokoconsulting.tech</maintainerurl>
|
||||||
|
<targetplatform name='joomla' version='(5|6).*'/>
|
||||||
|
<php_minimum>8.1</php_minimum>
|
||||||
|
</update>
|
||||||
|
|
||||||
|
<!-- 5. STABLE -->
|
||||||
|
<update>
|
||||||
|
<name>{{EXTENSION_NAME}}</name>
|
||||||
|
<description>{{EXTENSION_NAME}} — Moko Consulting Joomla extension.</description>
|
||||||
|
<element>{{EXTENSION_ELEMENT}}</element>
|
||||||
|
<type>{{EXTENSION_TYPE}}</type>
|
||||||
|
<folder>{{EXTENSION_FOLDER}}</folder>
|
||||||
|
<client>{{EXTENSION_CLIENT}}</client>
|
||||||
|
<version>{{VERSION}}</version>
|
||||||
|
<creationDate>{{DATE}}</creationDate>
|
||||||
|
<infourl title='{{EXTENSION_NAME}}'>https://git.mokoconsulting.tech/MokoConsulting/{{REPO_NAME}}/releases/tag/stable</infourl>
|
||||||
|
<downloads>
|
||||||
|
<downloadurl type='full' format='zip'>https://git.mokoconsulting.tech/MokoConsulting/{{REPO_NAME}}/releases/download/stable/{{EXTENSION_ELEMENT}}-{{VERSION}}.zip</downloadurl>
|
||||||
|
</downloads>
|
||||||
|
<sha256></sha256>
|
||||||
|
<tags><tag>stable</tag></tags>
|
||||||
|
<maintainer>Moko Consulting</maintainer>
|
||||||
|
<maintainerurl>https://mokoconsulting.tech</maintainerurl>
|
||||||
|
<targetplatform name='joomla' version='(5|6).*'/>
|
||||||
|
<php_minimum>8.1</php_minimum>
|
||||||
|
</update>
|
||||||
|
|
||||||
|
</updates>
|
||||||
Reference in New Issue
Block a user