File reorganization
This commit is contained in:
919
.github/workflows/release_pipeline.yml
vendored
919
.github/workflows/release_pipeline.yml
vendored
@@ -1,918 +1 @@
|
||||
# ============================================================================
|
||||
# Copyright (C) 2025 Moko Consulting <hello@mokoconsulting.tech>
|
||||
#
|
||||
# This file is part of a Moko Consulting project.
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation; either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
#
|
||||
# FILE INFORMATION
|
||||
# DEFGROUP: GitHub.Workflow
|
||||
# INGROUP: MokoStandards.Release
|
||||
# REPO: https://github.com/mokoconsulting-tech/MokoStandards
|
||||
# PATH: /.github/workflows/release_pipeline.yml
|
||||
# VERSION: 03.05.00
|
||||
# BRIEF: Enterprise release pipeline enforcing dev to rc to version to main. Creates prerelease when rc is created. Creates full release when version is created and promotes to main while retaining the version branch.
|
||||
# ============================================================================
|
||||
|
||||
name: Release Pipeline (dev > rc > version > main)
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
release_classification:
|
||||
description: "Manual override for classification. auto follows branch policy; rc forces prerelease behavior; stable forces full release behavior."
|
||||
required: true
|
||||
default: auto
|
||||
type: choice
|
||||
options:
|
||||
- auto
|
||||
- rc
|
||||
- stable
|
||||
release:
|
||||
types:
|
||||
- created
|
||||
- prereleased
|
||||
- published
|
||||
|
||||
concurrency:
|
||||
group: release-pipeline-${{ github.ref_name }}
|
||||
cancel-in-progress: false
|
||||
|
||||
defaults:
|
||||
run:
|
||||
shell: bash
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
guard:
|
||||
name: 00 Guard and derive promotion metadata
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
outputs:
|
||||
version: ${{ steps.meta.outputs.version }}
|
||||
source_branch: ${{ steps.meta.outputs.source_branch }}
|
||||
source_prefix: ${{ steps.meta.outputs.source_prefix }}
|
||||
target_branch: ${{ steps.meta.outputs.target_branch }}
|
||||
promoted_branch: ${{ steps.meta.outputs.promoted_branch }}
|
||||
today_utc: ${{ steps.meta.outputs.today_utc }}
|
||||
channel: ${{ steps.meta.outputs.channel }}
|
||||
release_mode: ${{ steps.meta.outputs.release_mode }}
|
||||
override: ${{ steps.meta.outputs.override }}
|
||||
|
||||
steps:
|
||||
- name: Verify actor has admin or maintain role
|
||||
env:
|
||||
GH_TOKEN: "${{ github.token }}"
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
ACTOR="${GITHUB_ACTOR}"
|
||||
REPO="${GITHUB_REPOSITORY}"
|
||||
|
||||
PERMISSION="$(gh api "/repos/${REPO}/collaborators/${ACTOR}/permission" --jq '.permission')"
|
||||
|
||||
{
|
||||
echo "### Authorization check"
|
||||
echo "```json"
|
||||
echo "{\"actor\":\"${ACTOR}\",\"permission\":\"${PERMISSION}\"}"
|
||||
echo "```"
|
||||
} >> "${GITHUB_STEP_SUMMARY}"
|
||||
|
||||
if [ "${PERMISSION}" != "admin" ] && [ "${PERMISSION}" != "maintain" ]; then
|
||||
echo "ERROR: Actor ${ACTOR} lacks required role (admin or maintain)." >> "${GITHUB_STEP_SUMMARY}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Validate trigger and extract metadata
|
||||
id: meta
|
||||
env:
|
||||
RELEASE_CLASSIFICATION: "${{ github.event.inputs.release_classification }}"
|
||||
RELEASE_PRERELEASE: "${{ github.event.release.prerelease }}"
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
|
||||
EVENT_NAME="${GITHUB_EVENT_NAME}"
|
||||
REF_NAME="${GITHUB_REF_NAME}"
|
||||
|
||||
VERSION=""
|
||||
SOURCE_BRANCH=""
|
||||
SOURCE_PREFIX=""
|
||||
TARGET_BRANCH=""
|
||||
PROMOTED_BRANCH=""
|
||||
CHANNEL=""
|
||||
RELEASE_MODE="none"
|
||||
|
||||
OVERRIDE="${RELEASE_CLASSIFICATION:-auto}"
|
||||
if [ -z "${OVERRIDE}" ]; then
|
||||
OVERRIDE="auto"
|
||||
fi
|
||||
|
||||
if [ "${EVENT_NAME}" = "workflow_dispatch" ]; then
|
||||
echo "${REF_NAME}" | grep -E '^(dev|rc)/[0-9]+[.][0-9]+[.][0-9]+$'
|
||||
|
||||
SOURCE_BRANCH="${REF_NAME}"
|
||||
SOURCE_PREFIX="${REF_NAME%%/*}"
|
||||
VERSION="${REF_NAME#*/}"
|
||||
|
||||
if [ "${SOURCE_PREFIX}" = "dev" ]; then
|
||||
TARGET_BRANCH="rc/${VERSION}"
|
||||
PROMOTED_BRANCH="rc/${VERSION}"
|
||||
CHANNEL="rc"
|
||||
RELEASE_MODE="prerelease"
|
||||
else
|
||||
TARGET_BRANCH="version/${VERSION}"
|
||||
PROMOTED_BRANCH="version/${VERSION}"
|
||||
CHANNEL="stable"
|
||||
RELEASE_MODE="stable"
|
||||
fi
|
||||
|
||||
if [ "${OVERRIDE}" = "rc" ]; then
|
||||
CHANNEL="rc"
|
||||
RELEASE_MODE="prerelease"
|
||||
elif [ "${OVERRIDE}" = "stable" ]; then
|
||||
CHANNEL="stable"
|
||||
RELEASE_MODE="stable"
|
||||
else
|
||||
OVERRIDE="auto"
|
||||
fi
|
||||
|
||||
elif [ "${EVENT_NAME}" = "release" ]; then
|
||||
TAG_NAME="${REF_NAME}"
|
||||
VERSION="${TAG_NAME#v}"
|
||||
VERSION="${VERSION%-rc}"
|
||||
echo "${VERSION}" | grep -E '^[0-9]+[.][0-9]+[.][0-9]+$'
|
||||
|
||||
if [ "${RELEASE_PRERELEASE:-false}" = "true" ]; then
|
||||
CHANNEL="rc"
|
||||
RELEASE_MODE="prerelease"
|
||||
else
|
||||
CHANNEL="stable"
|
||||
RELEASE_MODE="stable"
|
||||
fi
|
||||
|
||||
OVERRIDE="auto"
|
||||
|
||||
else
|
||||
echo "ERROR: Unsupported trigger ${EVENT_NAME}" >> "${GITHUB_STEP_SUMMARY}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
TODAY_UTC="$(date -u +%Y-%m-%d)"
|
||||
|
||||
echo "version=${VERSION}" >> "${GITHUB_OUTPUT}"
|
||||
echo "source_branch=${SOURCE_BRANCH}" >> "${GITHUB_OUTPUT}"
|
||||
echo "source_prefix=${SOURCE_PREFIX}" >> "${GITHUB_OUTPUT}"
|
||||
echo "target_branch=${TARGET_BRANCH}" >> "${GITHUB_OUTPUT}"
|
||||
echo "promoted_branch=${PROMOTED_BRANCH}" >> "${GITHUB_OUTPUT}"
|
||||
echo "today_utc=${TODAY_UTC}" >> "${GITHUB_OUTPUT}"
|
||||
echo "channel=${CHANNEL}" >> "${GITHUB_OUTPUT}"
|
||||
echo "release_mode=${RELEASE_MODE}" >> "${GITHUB_OUTPUT}"
|
||||
echo "override=${OVERRIDE}" >> "${GITHUB_OUTPUT}"
|
||||
|
||||
{
|
||||
echo "### Guard report"
|
||||
echo "```json"
|
||||
echo "{"
|
||||
echo " \"repository\": \"${GITHUB_REPOSITORY}\","
|
||||
echo " \"workflow\": \"${GITHUB_WORKFLOW}\","
|
||||
echo " \"job\": \"${GITHUB_JOB}\","
|
||||
echo " \"run_id\": ${GITHUB_RUN_ID},"
|
||||
echo " \"run_number\": ${GITHUB_RUN_NUMBER},"
|
||||
echo " \"run_attempt\": ${GITHUB_RUN_ATTEMPT},"
|
||||
echo " \"run_url\": \"${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}\","
|
||||
echo " \"actor\": \"${GITHUB_ACTOR}\","
|
||||
echo " \"sha\": \"${GITHUB_SHA}\","
|
||||
echo " \"event\": \"${EVENT_NAME}\","
|
||||
echo " \"ref\": \"${REF_NAME}\","
|
||||
echo " \"version\": \"${VERSION}\","
|
||||
echo " \"source_branch\": \"${SOURCE_BRANCH}\","
|
||||
echo " \"target_branch\": \"${TARGET_BRANCH}\","
|
||||
echo " \"promoted_branch\": \"${PROMOTED_BRANCH}\","
|
||||
echo " \"channel\": \"${CHANNEL}\","
|
||||
echo " \"release_mode\": \"${RELEASE_MODE}\","
|
||||
echo " \"override\": \"${OVERRIDE}\","
|
||||
echo " \"today_utc\": \"${TODAY_UTC}\""
|
||||
echo "}"
|
||||
echo "```"
|
||||
} >> "${GITHUB_STEP_SUMMARY}"
|
||||
|
||||
promote_branch:
|
||||
name: 01 Promote branch and delete source
|
||||
runs-on: ubuntu-latest
|
||||
needs: guard
|
||||
|
||||
if: ${{ github.event_name == 'workflow_dispatch' }}
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
steps:
|
||||
- name: Checkout source branch
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ needs.guard.outputs.source_branch }}
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Configure Git identity
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||
git config --global --add safe.directory "${GITHUB_WORKSPACE}"
|
||||
|
||||
- name: Enforce promotion preconditions
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
|
||||
SRC="${{ needs.guard.outputs.source_branch }}"
|
||||
DST="${{ needs.guard.outputs.target_branch }}"
|
||||
|
||||
git fetch origin --prune
|
||||
|
||||
if [ -z "${SRC}" ] || [ -z "${DST}" ]; then
|
||||
echo "ERROR: guard did not emit SRC or DST" >> "${GITHUB_STEP_SUMMARY}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if ! git show-ref --verify --quiet "refs/remotes/origin/${SRC}"; then
|
||||
echo "ERROR: origin/${SRC} not found" >> "${GITHUB_STEP_SUMMARY}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if git show-ref --verify --quiet "refs/remotes/origin/${DST}"; then
|
||||
echo "ERROR: origin/${DST} already exists" >> "${GITHUB_STEP_SUMMARY}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Promote and delete source
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
|
||||
SRC="${{ needs.guard.outputs.source_branch }}"
|
||||
DST="${{ needs.guard.outputs.target_branch }}"
|
||||
|
||||
git checkout -B "${DST}" "origin/${SRC}"
|
||||
git push origin "${DST}"
|
||||
git push origin --delete "${SRC}"
|
||||
|
||||
{
|
||||
echo "### Promotion report"
|
||||
echo "```json"
|
||||
echo "{"
|
||||
echo " \"repository\": \"${GITHUB_REPOSITORY}\","
|
||||
echo " \"workflow\": \"${GITHUB_WORKFLOW}\","
|
||||
echo " \"job\": \"${GITHUB_JOB}\","
|
||||
echo " \"run_id\": ${GITHUB_RUN_ID},"
|
||||
echo " \"run_number\": ${GITHUB_RUN_NUMBER},"
|
||||
echo " \"run_attempt\": ${GITHUB_RUN_ATTEMPT},"
|
||||
echo " \"run_url\": \"${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}\","
|
||||
echo " \"actor\": \"${GITHUB_ACTOR}\","
|
||||
echo " \"sha\": \"${GITHUB_SHA}\","
|
||||
echo " \"promoted\": \"${SRC} -> ${DST}\","
|
||||
echo " \"deleted\": \"${SRC}\""
|
||||
echo "}"
|
||||
echo "```"
|
||||
} >> "${GITHUB_STEP_SUMMARY}"
|
||||
|
||||
normalize_dates:
|
||||
name: 02 Normalize dates on promoted branch
|
||||
runs-on: ubuntu-latest
|
||||
needs:
|
||||
- guard
|
||||
- promote_branch
|
||||
|
||||
if: ${{ github.event_name == 'workflow_dispatch' }}
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
steps:
|
||||
- name: Checkout promoted branch
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ needs.guard.outputs.promoted_branch }}
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Configure Git identity
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||
git config --global --add safe.directory "${GITHUB_WORKSPACE}"
|
||||
|
||||
- name: Validate repo prerequisites
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
test -d src || (echo "ERROR: src directory missing" && exit 1)
|
||||
test -f CHANGELOG.md || (echo "ERROR: CHANGELOG.md missing" && exit 1)
|
||||
|
||||
VERSION="${{ needs.guard.outputs.version }}"
|
||||
|
||||
if ! grep -F "## [${VERSION}] " CHANGELOG.md >/dev/null; then
|
||||
echo "ERROR: CHANGELOG.md missing heading for version [${VERSION}]" >> "${GITHUB_STEP_SUMMARY}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Normalize dates using repository script only
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
|
||||
TODAY="${{ needs.guard.outputs.today_utc }}"
|
||||
VERSION="${{ needs.guard.outputs.version }}"
|
||||
|
||||
{
|
||||
echo "### Date normalization (repo script only)"
|
||||
echo "```json"
|
||||
echo "{\"today_utc\":\"${TODAY}\",\"version\":\"${VERSION}\"}"
|
||||
echo "```"
|
||||
} >> "${GITHUB_STEP_SUMMARY}"
|
||||
|
||||
CANDIDATES=(
|
||||
"scripts/update_dates.sh"
|
||||
"scripts/release/update_dates.sh"
|
||||
"scripts/release/update_dates"
|
||||
)
|
||||
|
||||
SCRIPT=""
|
||||
for c in "${CANDIDATES[@]}"; do
|
||||
if [ -f "${c}" ]; then
|
||||
SCRIPT="${c}"
|
||||
break
|
||||
fi
|
||||
done
|
||||
|
||||
if [ -z "${SCRIPT}" ]; then
|
||||
FOUND="$(find . -maxdepth 3 -type f \( -name 'update_dates.sh' -o -name 'update-dates.sh' \) 2>/dev/null | head -n 5 || true)"
|
||||
{
|
||||
echo "ERROR: Date normalization script not found in approved locations."
|
||||
echo "Approved locations:"
|
||||
printf '%s\n' "${CANDIDATES[@]}"
|
||||
echo "Discovered candidates (first 5):"
|
||||
echo "${FOUND:-<none>}"
|
||||
echo "Required action: add scripts/update_dates.sh (or scripts/release/update_dates.sh) to the repo."
|
||||
} >> "${GITHUB_STEP_SUMMARY}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Using date script: ${SCRIPT}" >> "${GITHUB_STEP_SUMMARY}"
|
||||
|
||||
chmod +x "${SCRIPT}"
|
||||
"${SCRIPT}" "${TODAY}" "${VERSION}" >> "${GITHUB_STEP_SUMMARY}"
|
||||
|
||||
{
|
||||
echo "### Date normalization diffstat"
|
||||
echo "```"
|
||||
git diff --stat || true
|
||||
echo "```"
|
||||
} >> "${GITHUB_STEP_SUMMARY}"
|
||||
|
||||
- name: Commit normalized dates (if changed)
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
if git diff --quiet; then
|
||||
echo "No date changes to commit" >> "${GITHUB_STEP_SUMMARY}"
|
||||
exit 0
|
||||
fi
|
||||
git add -A
|
||||
git commit -m "chore(release): normalize dates" || true
|
||||
git push origin "HEAD:${{ needs.guard.outputs.promoted_branch }}"
|
||||
|
||||
build_and_release:
|
||||
name: 03 Build ZIP, upload to SFTP, create GitHub release
|
||||
runs-on: ubuntu-latest
|
||||
needs:
|
||||
- guard
|
||||
- normalize_dates
|
||||
|
||||
if: ${{ github.event_name == 'workflow_dispatch' }}
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
id-token: write
|
||||
attestations: write
|
||||
|
||||
steps:
|
||||
- name: Checkout promoted branch
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ needs.guard.outputs.promoted_branch }}
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Configure Git identity
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||
git config --global --add safe.directory "${GITHUB_WORKSPACE}"
|
||||
|
||||
- name: Validate required secrets and variables
|
||||
env:
|
||||
FTP_HOST: "${{ secrets.FTP_HOST }}"
|
||||
FTP_USER: "${{ secrets.FTP_USER }}"
|
||||
FTP_KEY: "${{ secrets.FTP_KEY }}"
|
||||
FTP_PASSWORD: "${{ secrets.FTP_PASSWORD }}"
|
||||
FTP_PATH: "${{ secrets.FTP_PATH }}"
|
||||
FTP_PROTOCOL: "${{ secrets.FTP_PROTOCOL }}"
|
||||
FTP_PORT: "${{ secrets.FTP_PORT }}"
|
||||
FTP_PATH_SUFFIX: "${{ vars.FTP_PATH_SUFFIX }}"
|
||||
CHANNEL: "${{ needs.guard.outputs.channel }}"
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
missing=()
|
||||
|
||||
[ -n "${FTP_HOST:-}" ] || missing+=("FTP_HOST")
|
||||
[ -n "${FTP_USER:-}" ] || missing+=("FTP_USER")
|
||||
[ -n "${FTP_KEY:-}" ] || missing+=("FTP_KEY")
|
||||
[ -n "${FTP_PATH:-}" ] || missing+=("FTP_PATH")
|
||||
|
||||
proto="${FTP_PROTOCOL:-sftp}"
|
||||
if [ -n "${FTP_PROTOCOL:-}" ] && [ "${proto}" != "sftp" ]; then
|
||||
missing+=("FTP_PROTOCOL_INVALID")
|
||||
fi
|
||||
|
||||
first_line="$(printf '%s' "${FTP_KEY:-}" | head -n 1 || true)"
|
||||
if [ -n "${FTP_KEY:-}" ]; then
|
||||
if printf '%s' "${first_line}" | grep -q '^PuTTY-User-Key-File-'; then
|
||||
key_format="ppk"
|
||||
elif printf '%s' "${first_line}" | grep -q '^-----BEGIN '; then
|
||||
key_format="openssh"
|
||||
else
|
||||
key_format="unknown"
|
||||
missing+=("FTP_KEY_FORMAT")
|
||||
fi
|
||||
else
|
||||
key_format="missing"
|
||||
fi
|
||||
|
||||
{
|
||||
echo "### Configuration guardrails"
|
||||
echo "```json"
|
||||
printf '{"status":"%s","missing":[' "$( [ "${#missing[@]}" -gt 0 ] && echo fail || echo ok )"
|
||||
sep=""
|
||||
for m in "${missing[@]}"; do
|
||||
printf '%s"%s"' "${sep}" "${m}"
|
||||
sep=",";
|
||||
done
|
||||
printf '],"key_format":"%s","channel":"%s"}\n' "${key_format}" "${CHANNEL}"
|
||||
echo "```"
|
||||
} >> "${GITHUB_STEP_SUMMARY}"
|
||||
|
||||
if [ "${#missing[@]}" -gt 0 ]; then
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Run repository validation scripts (workflow-controlled)
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
|
||||
required_scripts=(
|
||||
"scripts/validate_manifest.sh"
|
||||
"scripts/validate_xml_wellformed.sh"
|
||||
)
|
||||
|
||||
optional_scripts=(
|
||||
"scripts/validate_changelog.sh"
|
||||
"scripts/validate_tabs.sh"
|
||||
"scripts/validate_paths.sh"
|
||||
"scripts/validate_version_alignment.sh"
|
||||
"scripts/validate_language_structure.sh"
|
||||
"scripts/validate_php_syntax.sh"
|
||||
"scripts/validate_no_secrets.sh"
|
||||
"scripts/validate_license_headers.sh"
|
||||
)
|
||||
|
||||
missing=()
|
||||
for s in "${required_scripts[@]}"; do
|
||||
if [ ! -f "${s}" ]; then
|
||||
missing+=("${s}")
|
||||
fi
|
||||
done
|
||||
|
||||
if [ "${#missing[@]}" -gt 0 ]; then
|
||||
{
|
||||
echo "### Script guardrails"
|
||||
echo "```json"
|
||||
printf '{"status":"fail","missing_required_scripts":['
|
||||
sep=""
|
||||
for m in "${missing[@]}"; do
|
||||
printf '%s"%s"' "${sep}" "${m}"
|
||||
sep=",";
|
||||
done
|
||||
printf ']}\n'
|
||||
echo "```"
|
||||
} >> "${GITHUB_STEP_SUMMARY}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
ran=()
|
||||
skipped=()
|
||||
|
||||
for s in "${required_scripts[@]}" "${optional_scripts[@]}"; do
|
||||
if [ -f "${s}" ]; then
|
||||
chmod +x "${s}"
|
||||
"${s}" >> "${GITHUB_STEP_SUMMARY}"
|
||||
ran+=("${s}")
|
||||
else
|
||||
skipped+=("${s}")
|
||||
fi
|
||||
done
|
||||
|
||||
{
|
||||
echo "### Script execution report"
|
||||
echo "```json"
|
||||
printf '{"ran":['
|
||||
sep=""
|
||||
for r in "${ran[@]}"; do
|
||||
printf '%s"%s"' "${sep}" "${r}"
|
||||
sep=",";
|
||||
done
|
||||
printf '],"skipped_optional":['
|
||||
sep=""
|
||||
for k in "${skipped[@]}"; do
|
||||
printf '%s"%s"' "${sep}" "${k}"
|
||||
sep=",";
|
||||
done
|
||||
printf ']}\\n'
|
||||
echo "```"
|
||||
} >> "${GITHUB_STEP_SUMMARY}"
|
||||
|
||||
- name: Build Joomla ZIP (extension type aware)
|
||||
id: build
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
|
||||
VERSION="${{ needs.guard.outputs.version }}"
|
||||
REPO_NAME="${{ github.event.repository.name }}"
|
||||
CHANNEL="${{ needs.guard.outputs.channel }}"
|
||||
|
||||
test -d src || (echo "ERROR: src directory missing" && exit 1)
|
||||
|
||||
DIST_DIR="${GITHUB_WORKSPACE}/dist"
|
||||
mkdir -p "${DIST_DIR}"
|
||||
|
||||
MANIFEST=""
|
||||
if [ -f "src/templateDetails.xml" ]; then
|
||||
MANIFEST="src/templateDetails.xml"
|
||||
elif find src -maxdepth 4 -type f -name 'templateDetails.xml' | head -n 1 | grep -q .; then
|
||||
MANIFEST="$(find src -maxdepth 4 -type f -name 'templateDetails.xml' | head -n 1)"
|
||||
elif find src -maxdepth 4 -type f -name 'pkg_*.xml' | head -n 1 | grep -q .; then
|
||||
MANIFEST="$(find src -maxdepth 4 -type f -name 'pkg_*.xml' | head -n 1)"
|
||||
elif find src -maxdepth 4 -type f -name 'com_*.xml' | head -n 1 | grep -q .; then
|
||||
MANIFEST="$(find src -maxdepth 4 -type f -name 'com_*.xml' | head -n 1)"
|
||||
elif find src -maxdepth 4 -type f -name 'mod_*.xml' | head -n 1 | grep -q .; then
|
||||
MANIFEST="$(find src -maxdepth 4 -type f -name 'mod_*.xml' | head -n 1)"
|
||||
elif find src -maxdepth 6 -type f -name 'plg_*.xml' | head -n 1 | grep -q .; then
|
||||
MANIFEST="$(find src -maxdepth 6 -type f -name 'plg_*.xml' | head -n 1)"
|
||||
else
|
||||
MANIFEST="$(grep -Rsl --include='*.xml' '<extension' src | head -n 1 || true)"
|
||||
fi
|
||||
|
||||
if [ -z "${MANIFEST}" ]; then
|
||||
echo "ERROR: No Joomla manifest XML found under src" >> "${GITHUB_STEP_SUMMARY}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
EXT_TYPE="$(grep -Eo 'type="[^"]+"' "${MANIFEST}" | head -n 1 | cut -d '"' -f2 || true)"
|
||||
if [ -z "${EXT_TYPE}" ]; then
|
||||
EXT_TYPE="unknown"
|
||||
fi
|
||||
|
||||
ROOT="$(dirname "${MANIFEST}")"
|
||||
|
||||
ZIP="${REPO_NAME}-${VERSION}-${CHANNEL}-${EXT_TYPE}.zip"
|
||||
|
||||
(cd "${ROOT}" && zip -r -X "${DIST_DIR}/${ZIP}" . \
|
||||
-x "**/.git/**" \
|
||||
-x "**/.github/**" \
|
||||
-x "**/.DS_Store" \
|
||||
-x "**/__MACOSX/**")
|
||||
|
||||
echo "zip_name=${ZIP}" >> "${GITHUB_OUTPUT}"
|
||||
echo "dist_dir=${DIST_DIR}" >> "${GITHUB_OUTPUT}"
|
||||
echo "root=${ROOT}" >> "${GITHUB_OUTPUT}"
|
||||
echo "manifest=${MANIFEST}" >> "${GITHUB_OUTPUT}"
|
||||
echo "ext_type=${EXT_TYPE}" >> "${GITHUB_OUTPUT}"
|
||||
|
||||
ZIP_BYTES="$(stat -c%s "${DIST_DIR}/${ZIP}")"
|
||||
|
||||
{
|
||||
echo "### Build report"
|
||||
echo "```json"
|
||||
echo "{\"repository\":\"${GITHUB_REPOSITORY}\",\"workflow\":\"${GITHUB_WORKFLOW}\",\"job\":\"${GITHUB_JOB}\",\"run_id\":${GITHUB_RUN_ID},\"run_number\":${GITHUB_RUN_NUMBER},\"run_attempt\":${GITHUB_RUN_ATTEMPT},\"run_url\":\"${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}\",\"actor\":\"${GITHUB_ACTOR}\",\"sha\":\"${GITHUB_SHA}\",\"root\":\"${ROOT}\",\"manifest\":\"${MANIFEST}\",\"extension_type\":\"${EXT_TYPE}\",\"zip\":\"${DIST_DIR}/${ZIP}\",\"zip_bytes\":${ZIP_BYTES}}"
|
||||
echo "```"
|
||||
} >> "${GITHUB_STEP_SUMMARY}"
|
||||
|
||||
- name: Upload ZIP to SFTP (key-only, overwrite, verbose)
|
||||
env:
|
||||
FTP_HOST: "${{ secrets.FTP_HOST }}"
|
||||
FTP_USER: "${{ secrets.FTP_USER }}"
|
||||
FTP_KEY: "${{ secrets.FTP_KEY }}"
|
||||
FTP_PASSWORD: "${{ secrets.FTP_PASSWORD }}"
|
||||
FTP_PATH: "${{ secrets.FTP_PATH }}"
|
||||
FTP_PROTOCOL: "${{ secrets.FTP_PROTOCOL }}"
|
||||
FTP_PORT: "${{ secrets.FTP_PORT }}"
|
||||
FTP_PATH_SUFFIX: "${{ vars.FTP_PATH_SUFFIX }}"
|
||||
CHANNEL: "${{ needs.guard.outputs.channel }}"
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
ZIP="${{ steps.build.outputs.zip_name }}"
|
||||
|
||||
: "${FTP_HOST:?Missing secret FTP_HOST}"
|
||||
: "${FTP_USER:?Missing secret FTP_USER}"
|
||||
: "${FTP_KEY:?Missing secret FTP_KEY}"
|
||||
: "${FTP_PATH:?Missing secret FTP_PATH}"
|
||||
|
||||
PROTOCOL="${FTP_PROTOCOL:-sftp}"
|
||||
if [ "${PROTOCOL}" != "sftp" ]; then
|
||||
echo "ERROR: Only SFTP permitted" >> "${GITHUB_STEP_SUMMARY}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
PORT="${FTP_PORT:-}"
|
||||
if [ -n "${PORT}" ]; then
|
||||
HOSTPORT="${FTP_HOST}:${PORT}"
|
||||
else
|
||||
HOSTPORT="${FTP_HOST}"
|
||||
fi
|
||||
|
||||
SUFFIX="${FTP_PATH_SUFFIX:-}"
|
||||
if [ -n "${SUFFIX}" ]; then
|
||||
REMOTE_PATH="${FTP_PATH%/}/${SUFFIX%/}/${CHANNEL}"
|
||||
else
|
||||
REMOTE_PATH="${FTP_PATH%/}/${CHANNEL}"
|
||||
fi
|
||||
|
||||
echo "SFTP target: sftp://${HOSTPORT}${REMOTE_PATH}" >> "${GITHUB_STEP_SUMMARY}"
|
||||
|
||||
sudo apt-get update -y
|
||||
sudo apt-get install -y lftp openssh-client putty-tools
|
||||
|
||||
mkdir -p ~/.ssh
|
||||
|
||||
if printf '%s' "${FTP_KEY}" | head -n 1 | grep -q '^PuTTY-User-Key-File-'; then
|
||||
printf '%s' "${FTP_KEY}" > ~/.ssh/key.ppk
|
||||
chmod 600 ~/.ssh/key.ppk
|
||||
|
||||
if grep -Eq '^Encryption: *none[[:space:]]*$' ~/.ssh/key.ppk; then
|
||||
PPK_PASSPHRASE=""
|
||||
else
|
||||
if [ -z "${FTP_PASSWORD:-}" ]; then
|
||||
echo "ERROR: Encrypted PPK detected but FTP_PASSWORD not provided" >> "${GITHUB_STEP_SUMMARY}"
|
||||
exit 1
|
||||
fi
|
||||
PPK_PASSPHRASE="${FTP_PASSWORD:-}"
|
||||
fi
|
||||
|
||||
if [ -n "${PPK_PASSPHRASE}" ]; then
|
||||
puttygen ~/.ssh/key.ppk -O private-openssh --passphrase "${PPK_PASSPHRASE}" -o ~/.ssh/id_rsa
|
||||
else
|
||||
puttygen ~/.ssh/key.ppk -O private-openssh -o ~/.ssh/id_rsa
|
||||
fi
|
||||
|
||||
if [ ! -s ~/.ssh/id_rsa ]; then
|
||||
echo "ERROR: PPK conversion failed" >> "${GITHUB_STEP_SUMMARY}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
chmod 600 ~/.ssh/id_rsa
|
||||
rm -f ~/.ssh/key.ppk
|
||||
else
|
||||
printf '%s' "${FTP_KEY}" > ~/.ssh/id_rsa
|
||||
chmod 600 ~/.ssh/id_rsa
|
||||
fi
|
||||
|
||||
ssh-keyscan -H "${FTP_HOST}" >> ~/.ssh/known_hosts
|
||||
|
||||
lftp -d -e "\
|
||||
set sftp:auto-confirm yes; \
|
||||
set cmd:trace yes; \
|
||||
set net:timeout 30; \
|
||||
set net:max-retries 3; \
|
||||
set net:reconnect-interval-base 5; \
|
||||
set sftp:connect-program 'ssh -a -x -i ~/.ssh/id_rsa -o PasswordAuthentication=no -o KbdInteractiveAuthentication=no -o ChallengeResponseAuthentication=no -o PubkeyAuthentication=yes'; \
|
||||
open -u '${FTP_USER}', sftp://${HOSTPORT}; \
|
||||
mkdir -p '${REMOTE_PATH}'; \
|
||||
cd '${REMOTE_PATH}'; \
|
||||
put -E '${{ steps.build.outputs.dist_dir }}/${ZIP}'; \
|
||||
ls; \
|
||||
bye"
|
||||
|
||||
ZIP_BYTES="$(stat -c%s "${{ steps.build.outputs.dist_dir }}/${ZIP}")"
|
||||
{
|
||||
echo "### SFTP upload report"
|
||||
echo "```json"
|
||||
echo "{\"protocol\":\"sftp\",\"host\":\"${FTP_HOST}\",\"port\":\"${PORT:-default}\",\"remote_path\":\"${REMOTE_PATH}\",\"zip\":\"${ZIP}\",\"zip_bytes\":${ZIP_BYTES},\"overwrite\":true,\"key_only\":true}"
|
||||
echo "```"
|
||||
} >> "${GITHUB_STEP_SUMMARY}"
|
||||
|
||||
- name: Create Git tag
|
||||
id: tag
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
|
||||
VERSION="${{ needs.guard.outputs.version }}"
|
||||
MODE="${{ needs.guard.outputs.release_mode }}"
|
||||
|
||||
if [ "${MODE}" = "prerelease" ]; then
|
||||
TAG="v${VERSION}-rc"
|
||||
else
|
||||
TAG="v${VERSION}"
|
||||
fi
|
||||
|
||||
git fetch --tags
|
||||
if git rev-parse -q --verify "refs/tags/${TAG}" >/dev/null; then
|
||||
echo "Tag ${TAG} already exists" >> "${GITHUB_STEP_SUMMARY}"
|
||||
else
|
||||
git tag -a "${TAG}" -m "${MODE} ${VERSION}"
|
||||
git push origin "refs/tags/${TAG}"
|
||||
fi
|
||||
|
||||
echo "tag=${TAG}" >> "${GITHUB_OUTPUT}"
|
||||
|
||||
- name: Generate release notes from CHANGELOG.md
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
|
||||
VERSION="${{ needs.guard.outputs.version }}"
|
||||
ZIP_ASSET="${{ steps.build.outputs.zip_name }}"
|
||||
|
||||
awk "/^## \[${VERSION}\]/{flag=1;next}/^## \[/ {flag=0}flag" CHANGELOG.md > RELEASE_NOTES.md || true
|
||||
|
||||
if [ ! -s RELEASE_NOTES.md ]; then
|
||||
echo "ERROR: Release notes extraction failed for ${VERSION}" >> "${GITHUB_STEP_SUMMARY}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
{
|
||||
echo ""
|
||||
echo "Assets:"
|
||||
echo "- ${ZIP_ASSET}"
|
||||
} >> RELEASE_NOTES.md
|
||||
|
||||
- name: Create GitHub release and attach ZIP
|
||||
uses: softprops/action-gh-release@v2
|
||||
with:
|
||||
tag_name: ${{ steps.tag.outputs.tag }}
|
||||
name: ${{ needs.guard.outputs.release_mode }} ${{ needs.guard.outputs.version }}
|
||||
prerelease: ${{ needs.guard.outputs.release_mode == 'prerelease' }}
|
||||
body_path: RELEASE_NOTES.md
|
||||
files: |
|
||||
dist/*.zip
|
||||
|
||||
- name: Attest build provenance
|
||||
uses: actions/attest-build-provenance@v2
|
||||
with:
|
||||
subject-path: |
|
||||
dist/*.zip
|
||||
|
||||
- name: Publish release report
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
|
||||
echo "### Release report (JSON)" >> "${GITHUB_STEP_SUMMARY}"
|
||||
echo "```json" >> "${GITHUB_STEP_SUMMARY}"
|
||||
printf '{"repository":"%s","workflow":"%s","job":"%s","run_id":%s,"run_number":%s,"run_attempt":%s,"run_url":"%s","actor":"%s","sha":"%s","version":"%s","branch":"%s","tag":"%s","mode":"%s","channel":"%s","override":"%s","zip":"%s"}\n' \
|
||||
"${GITHUB_REPOSITORY}" \
|
||||
"${GITHUB_WORKFLOW}" \
|
||||
"${GITHUB_JOB}" \
|
||||
"${GITHUB_RUN_ID}" \
|
||||
"${GITHUB_RUN_NUMBER}" \
|
||||
"${GITHUB_RUN_ATTEMPT}" \
|
||||
"${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}" \
|
||||
"${GITHUB_ACTOR}" \
|
||||
"${GITHUB_SHA}" \
|
||||
"${{ needs.guard.outputs.version }}" \
|
||||
"${{ needs.guard.outputs.promoted_branch }}" \
|
||||
"${{ steps.tag.outputs.tag }}" \
|
||||
"${{ needs.guard.outputs.release_mode }}" \
|
||||
"${{ needs.guard.outputs.channel }}" \
|
||||
"${{ needs.guard.outputs.override }}" \
|
||||
"${{ steps.build.outputs.zip_name }}" >> "${GITHUB_STEP_SUMMARY}"
|
||||
echo "```" >> "${GITHUB_STEP_SUMMARY}"
|
||||
|
||||
push_version_to_main:
|
||||
name: 04 Promote version branch to main (stable only, keep version branch)
|
||||
runs-on: ubuntu-latest
|
||||
needs:
|
||||
- guard
|
||||
- build_and_release
|
||||
|
||||
if: ${{ github.event_name == 'workflow_dispatch' && needs.guard.outputs.release_mode == 'stable' }}
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
|
||||
steps:
|
||||
- name: Checkout main
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: main
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Configure Git identity
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||
git config --global --add safe.directory "${GITHUB_WORKSPACE}"
|
||||
|
||||
- name: Create PR from version branch to main
|
||||
env:
|
||||
GH_TOKEN: "${{ github.token }}"
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
VERSION="${{ needs.guard.outputs.version }}"
|
||||
HEAD="${{ needs.guard.outputs.promoted_branch }}"
|
||||
|
||||
gh pr create \
|
||||
--base main \
|
||||
--head "${HEAD}" \
|
||||
--title "Release ${VERSION} to main" \
|
||||
--body "Automated PR created by release pipeline. Version branch is retained by policy." \
|
||||
|| true
|
||||
|
||||
- name: Attempt to merge PR (best-effort)
|
||||
env:
|
||||
GH_TOKEN: "${{ github.token }}"
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
HEAD="${{ needs.guard.outputs.promoted_branch }}"
|
||||
PR_NUMBER="$(gh pr list --head "${HEAD}" --base main --json number --jq '.[0].number' || true)"
|
||||
|
||||
if [ -z "${PR_NUMBER}" ] || [ "${PR_NUMBER}" = "null" ]; then
|
||||
echo "ERROR: PR not found for head ${HEAD}" >> "${GITHUB_STEP_SUMMARY}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
gh pr merge "${PR_NUMBER}" --merge --delete-branch=false \
|
||||
|| echo "PR merge blocked by branch protection or policy" >> "${GITHUB_STEP_SUMMARY}"
|
||||
|
||||
{
|
||||
echo "### Main branch promotion"
|
||||
echo "```json"
|
||||
echo "{\"head\":\"${HEAD}\",\"pr\":${PR_NUMBER}}"
|
||||
echo "```"
|
||||
} >> "${GITHUB_STEP_SUMMARY}"
|
||||
|
||||
release_event_report:
|
||||
name: 99 Release event report (GitHub UI created release)
|
||||
runs-on: ubuntu-latest
|
||||
needs: guard
|
||||
|
||||
if: ${{ github.event_name == 'release' }}
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
steps:
|
||||
- name: Checkout tag
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ github.ref_name }}
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Publish JSON report to job summary
|
||||
env:
|
||||
IS_PRERELEASE: "${{ github.event.release.prerelease }}"
|
||||
run: |
|
||||
set -euxo pipefail
|
||||
|
||||
VERSION="${{ needs.guard.outputs.version }}"
|
||||
TAG="${{ github.ref_name }}"
|
||||
|
||||
echo "### Release event report (JSON)" >> "${GITHUB_STEP_SUMMARY}"
|
||||
echo "```json" >> "${GITHUB_STEP_SUMMARY}"
|
||||
printf '{"repository":"%s","workflow":"%s","job":"%s","run_id":%s,"run_number":%s,"run_attempt":%s,"run_url":"%s","actor":"%s","sha":"%s","version":"%s","tag":"%s","prerelease":%s}\n' \
|
||||
"${GITHUB_REPOSITORY}" \
|
||||
"${GITHUB_WORKFLOW}" \
|
||||
"${GITHUB_JOB}" \
|
||||
"${GITHUB_RUN_ID}" \
|
||||
"${GITHUB_RUN_NUMBER}" \
|
||||
"${GITHUB_RUN_ATTEMPT}" \
|
||||
"${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}" \
|
||||
"${GITHUB_ACTOR}" \
|
||||
"${GITHUB_SHA}" \
|
||||
"${VERSION}" \
|
||||
"${TAG}" \
|
||||
"${IS_PRERELEASE}" >> "${GITHUB_STEP_SUMMARY}"
|
||||
echo "```" >> "${GITHUB_STEP_SUMMARY}"
|
||||
also generate best case scenrio for needed files and other hierarchy
|
||||
|
||||
0
scripts/lib/joomla_manifest.sh
Normal file
0
scripts/lib/joomla_manifest.sh
Normal file
@@ -21,7 +21,7 @@
|
||||
# FILE INFORMATION
|
||||
# DEFGROUP: MokoStandards
|
||||
# INGROUP: Generic.Script
|
||||
# REPO: https://github.com/mokoconsulting-tech/MokoDefaults
|
||||
# REPO: https://github.com/mokoconsulting-tech/MokoStandards
|
||||
# PATH: /scripts/update_changelog.sh
|
||||
# VERSION: 03.05.00
|
||||
# BRIEF: Insert a versioned CHANGELOG.md entry immediately after the main Changelog heading
|
||||
0
scripts/run/smoke_test.sh
Normal file
0
scripts/run/smoke_test.sh
Normal file
Reference in New Issue
Block a user