MokoConsulting/MokoGitea-APP
1
0
Fork 0
Code Issues 158 Pull Requests 3 Releases 96 Wiki Activity

feat: generate Joomla changelog XML for update server <changelogurl> #343

New Issue
Closed
opened 2026-05-31 15:09:04 +00:00 by jmiller · 2 comments
jmiller commented 2026-05-31 15:09:04 +00:00
Owner
Copy Link
Copy Source

Problem

The <changelogurl> in updates.xml points to raw CHANGELOG.md:

https://git.mokoconsulting.tech/Org/Repo/raw/branch/main/CHANGELOG.md

Joomla's update UI cannot render markdown. It expects a specific XML format:

<changelogs>
  <changelog>
    <element>pkg_mokowaas</element>
    <type>package</type>
    <version>02.29.04</version>
    <security>
      <item>Fixed XSS in admin panel</item>
    </security>
    <fix>
      <item>Resolved database timeout on large queries</item>
    </fix>
    <addition>
      <item>Added dark mode support</item>
    </addition>
    <change>
      <item>Updated minimum PHP to 8.2</item>
    </change>
    <note>
      <item>See release notes for migration guide</item>
    </note>
  </changelog>
</changelogs>

Proposal

  1. Generate changelog.xml from CHANGELOG.md during the release workflow
  2. Parse Keep-a-Changelog format sections (Added, Changed, Fixed, Security, etc.) into Joomla XML categories
  3. Host the generated XML alongside updates.xml in the repo
  4. Update <changelogurl> to point to the XML file instead of raw markdown

Mapping

CHANGELOG.md Section Joomla XML Element
Added <addition>
Changed <change>
Fixed <fix>
Security <security>
Removed <change>
Deprecated <note>

Implementation Options

A) CLI tool in moko-platform that generates changelog.xml from CHANGELOG.md
B) Workflow step in update-server.yml that generates it during release
C) MokoGitea API endpoint that dynamically converts CHANGELOG.md to XML

Related

## Problem The `<changelogurl>` in updates.xml points to raw CHANGELOG.md: ``` https://git.mokoconsulting.tech/Org/Repo/raw/branch/main/CHANGELOG.md ``` Joomla's update UI cannot render markdown. It expects a specific XML format: ```xml <changelogs> <changelog> <element>pkg_mokowaas</element> <type>package</type> <version>02.29.04</version> <security> <item>Fixed XSS in admin panel</item> </security> <fix> <item>Resolved database timeout on large queries</item> </fix> <addition> <item>Added dark mode support</item> </addition> <change> <item>Updated minimum PHP to 8.2</item> </change> <note> <item>See release notes for migration guide</item> </note> </changelog> </changelogs> ``` ## Proposal 1. Generate `changelog.xml` from CHANGELOG.md during the release workflow 2. Parse Keep-a-Changelog format sections (Added, Changed, Fixed, Security, etc.) into Joomla XML categories 3. Host the generated XML alongside updates.xml in the repo 4. Update `<changelogurl>` to point to the XML file instead of raw markdown ## Mapping | CHANGELOG.md Section | Joomla XML Element | |---------------------|--------------------| | Added | `<addition>` | | Changed | `<change>` | | Fixed | `<fix>` | | Security | `<security>` | | Removed | `<change>` | | Deprecated | `<note>` | ## Implementation Options A) CLI tool in moko-platform that generates changelog.xml from CHANGELOG.md B) Workflow step in update-server.yml that generates it during release C) MokoGitea API endpoint that dynamically converts CHANGELOG.md to XML ## Related - Licensing system update stream integration - moko-platform `cli/updates_xml_build.php` generates `<changelogurl>` - Joomla update XML spec: https://docs.joomla.org/Deploying_an_Update_Server
jmiller commented 2026-06-01 10:12:07 +00:00
Author
Owner
Copy Link
Copy Source

Testing Plan — Changelog XML

API

  • GET /{owner}/{repo}/changelog.xml → 200, valid XML
  • XML has root element
  • Each release → with element, type, version
  • Release with "### Fixed" section → elements
  • Release with "### Added" section → elements
  • Release with "### Security" section → elements
  • Release with "### Changed" →
  • Release with no markdown sections → entire note as
  • Draft releases excluded
  • Element and type from extension metadata config
  • updates.xml points to /changelog.xml

GUI

  • Changelog XML URL shown in update feed URLs section
  • Copy button works

🤖 Generated with Claude Code

## Testing Plan — Changelog XML ### API - [ ] GET /{owner}/{repo}/changelog.xml → 200, valid XML - [ ] XML has <changelogs> root element - [ ] Each release → <changelog> with element, type, version - [ ] Release with "### Fixed" section → <fix><item> elements - [ ] Release with "### Added" section → <addition><item> elements - [ ] Release with "### Security" section → <security><item> elements - [ ] Release with "### Changed" → <change><item> - [ ] Release with no markdown sections → entire note as <note><item> - [ ] Draft releases excluded - [ ] Element and type from extension metadata config - [ ] updates.xml <changelogurl> points to /changelog.xml ### GUI - [ ] Changelog XML URL shown in update feed URLs section - [ ] Copy button works 🤖 Generated with [Claude Code](https://claude.com/claude-code)
jmiller reopened this issue 2026-06-02 11:21:40 +00:00
jmiller commented 2026-06-03 00:39:41 +00:00
Author
Owner
Copy Link
Copy Source

Tested and verified in production on MokoWaaS. All three download gating modes (none/prerelease/all), feed visibility, XML metadata, download URLs, and access control confirmed working.

Tested and verified in production on MokoWaaS. All three download gating modes (none/prerelease/all), feed visibility, XML metadata, download URLs, and access control confirmed working.
Sign in to join this conversation.
Labels
Clear labels
breaking-change
Breaking API or behavior change
 ci-cd
CI/CD pipeline changes
 config
Configuration changes
 dependencies
Dependency updates
 deploy-failure
Deployment failed
 docker
Docker/container changes
 documentation
Documentation changes
 good first issue
Good for newcomers
 health-check
Repo health check result
 help wanted
Extra attention needed
 mokostandards
Related to MokoStandards framework
 push-failure
Git push operation failed
 security
Security vulnerability or hardening
 size/l
200-500 lines changed
 size/m
50-200 lines changed
 size/s
10-50 lines changed
 size/xl
500+ lines changed
 size/xs
< 10 lines changed
 standards-drift
Deviates from MokoStandards
 standards-update
MokoStandards compliance update
 sync-failure
Sync or mirror failed
 tech-debt
Technical debt and TODO/FIXME items
 upstream
upstream
Inherited from upstream Gitea
 work-in-progress
Draft or incomplete work
No labels
Priority Medium
Type Feature
Milestone
No items
No Milestone
Assignees
Clear assignees
jmiller (Jonathan Miller) moko-deploy (Moko Deploy Bot)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: MokoConsulting/MokoGitea-APP#343
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?