RFC Feature Composer Dependency Changed PR-5.1-dev Pending

User tests: Successful: Unsuccessful:

avatar C-Lodder
C-Lodder
14 Dec 2023

Summary of Changes

Requesting feedback. Happy to close if it's not desired.

This PR adds support for Markdown changelogs in extensions, which are commonly used nowdays.

image

Caveat

Unlike the XML based changelog which only displays the changes for the most recent version, this will display the entire changelog, as I don't think there will be a way to single out a specific version that easily with markdown.

avatar C-Lodder C-Lodder - open - 14 Dec 2023
avatar C-Lodder C-Lodder - change - 14 Dec 2023
Status New Pending
avatar joomla-cms-bot joomla-cms-bot - change - 14 Dec 2023
Category Administration com_installer External Library Composer Change Layout Libraries
avatar C-Lodder C-Lodder - change - 14 Dec 2023
The description was changed
avatar C-Lodder C-Lodder - edited - 14 Dec 2023
avatar C-Lodder C-Lodder - change - 14 Dec 2023
The description was changed
avatar C-Lodder C-Lodder - edited - 14 Dec 2023
avatar bembelimen bembelimen - change - 3 Jan 2024
Labels Added: RFC Feature Composer Dependency Changed PR-5.0-dev
avatar HLeithner
HLeithner - comment - 21 Jan 2024

I'm not so sure if this make sense, since we pull the html already from the developer website, I don't see a reason why we should render the markdown on our end when the developer can do this while creating the download package.

avatar C-Lodder
C-Lodder - comment - 22 Jan 2024

@HLeithner

I don't see a reason why we should render the markdown on our end when the developer can do this while creating the download package

The changelog source is already parsed by Joomla. The developer doesn't perform any parsing, or use HTML. They're currently being forced to create XML based changelogs. Personally, I have never seen XML changelogs, other than in Joomla stuff.

So, the point of this is is to allow extension developers to ship Markdown based changelogs, which are pretty common in FOSS

Examples of projects using Markdown changelogs: Laravel, Symphony, Node.js, Vue.js, React.js, PHPMailer, Apache, Lighthouse....

avatar HLeithner
HLeithner - comment - 22 Jan 2024

hmm true, I misinterpreted the code for xml changelogs, I will bring it up in the next maintainer meeting.

avatar Fedik
Fedik - comment - 22 Jan 2024

A main drawback with MD you already wrote:

Unlike the XML based changelog which only displays the changes for the most recent version, this will display the entire changelog,

Current implementation able to load whole XML and parse only the changelog for specific version.
So for "Extension Update" page it shows changelog for update,
And for "Extension Manage" page it shows changelog for currently installed version.

MD will not allow it. Unless we rewrite our Changelog API to work differently from what it is now.

avatar brianteeman
brianteeman - comment - 22 Jan 2024

@Fedik thats true but there is an existing feature request for it to show the entire changelog

avatar Fedik
Fedik - comment - 22 Jan 2024

Yeah right, I just wanted to clarify current state, and point out that it is not that simple as it may sounds :)

avatar laoneo
laoneo - comment - 24 Jan 2024

MD will not allow it. Unless we rewrite our Changelog API to work differently from what it is now.

It would be ok to just display the whole md content instead of the the specific version when only an MD file is available.

avatar C-Lodder
C-Lodder - comment - 4 Mar 2024

@HLeithner What was the outcome of the maintainers meeting?

avatar HLeithner HLeithner - change - 4 Mar 2024
Status Pending Closed
Closed_Date 0000-00-00 00:00:00 2024-03-04 08:16:34
Closed_By HLeithner
Labels Added: PR-5.1-dev
Removed: PR-5.0-dev
avatar HLeithner
HLeithner - comment - 4 Mar 2024

I'm sorry that the outcome of the meeting didn't make it's why to the PR.

We had a lengthy discussion if we want to add another library just for displaying changed logs for especially a feature which can easily implemented in a CI. Which doesn't mean that this is completely impossible in the future.

Also this variant has the drawback (compared to xml changelogs) that it's not possible to show only version relevant parts of the log.

Never the less the missing feature to show the complete changelog could be achieved by adding a link to the complete changelog.

So I'm closing this for now, any way thanks for your work even if it doesn't make it in to the core.

avatar HLeithner HLeithner - close - 4 Mar 2024

Add a Comment

Login with GitHub to post a comment