[4.0] Show changelog - GSoC Expand Extensions Manager #17536 redo

[roland-d]

Redo

This is a continuation of issue #17536 as I can no longer push to that repo, starting a new PR.

Introduction

At this time, users have to look for external sources of information about changes in an extension, when they are going to update their extensions. In most cases, users install an extension without checking the changelog due to the difficulty to find the associated changelog. With this new feature, users can review the changelog of the extensions when they are about to install an update (granted that the changelog is provided by the extension's developer), and after the extension is installed.

Summary of Changes

Added a new parameter on the xml updateserver files 'changelogurl' and adding it to #__updates table.

Testing Instructions

1. Apply this pull request
2. Run the command npm ci to compile the JavaScript
3. Login to the administrator side
4. Go to Extensions -> Database -> Fix to make sure the database changes are applied
   
5. Install the test extension from https://github.com/roland-d/component_joomla/releases/tag/v0.0.2
6. Go to Manage
7. Filter the list on List of Students
8. Click on the version number 0.0.2
9. A modal shows up with the changelog as shown below under Manage View
10. Go to Update
11. Click on Find Updates
12. The update is shown and click on the Changelog button
13. A modal shows up with the changelog as shown below under Update View

Changelog format

The changelogurl is supported for all extensions, you just need to add tags in your installation xml with a valid url.
<changelogurl>https://rolandd.com/24026/changelog.xml</changelogurl>

The format of the XML file is as follows:

<changelogs>
    <changelog>
        <element>com_lists</element>
        <type>component</type>
        <version>4.0.0</version>
        <security>
            <item>Item A</item>
            <item>Item b</item>
        </security>
        <fix>
            <item>Item A</item>
            <item>Item b</item>
        </fix>
        <language>
            <item>Item A</item>
            <item>Item b</item>
        </language>
        <addition>
            <item>Item A</item>
            <item>Item b</item>
        </addition>
        <change>
            <item>Item A</item>
            <item>Item b</item>
        </change>
        <remove>
            <item>Item A</item>
            <item>Item b</item>
        </remove>
        <note>
            <item>Item A</item>
            <item>Item b</item>
        </note>
</changelog>
<changelog>
	<element>com_lists</element>
	<type>component</type>
	<version>0.0.2</version>
	<security>
		<item>Big issue</item>
	</security>
</changelog>
</changelogs>

This file contains 2 changelogs:

• Version 0.0.2 (for testing the manage view)
• Version 4.0.0 (for testing the update view)

Update View
Install the List component https://github.com/roland-d/component_joomla/releases/tag/v0.0.2
By default you will have always an update from 0.0.2 to 4.0.0 just for testing

If the changelog is not available it will show N/A like in the Folder column

It will open a modal window that loads the changelog via AJAX from the given changelog URL.
The title of the modal is version ' - ' component_name

Manage View
On the manage view the changelog is triggered by clicking on the version number.

Expected result

In Updates View you will have a new column that will show a changelog button to open a modal if there is a changelogurl in the #__updates table.
In Manage View you will have an tag in the version with a info icon on the right side if your extension has a changelogurl in the #__extensions table.

Documentation Changes Required

Add changelogurl parameter on updatesite information and in extension.
Add changelog XML format to updatesite information

[brianteeman]

The title of the modal is version ' - ' component_name

The modal must have a title - I would suggest Changelog - component_name

For the title it is better to present the component_name before the version number

[wilsonge]

@roland-d i'm done with merge conflicts for a bit so coming back to this. Can you fix the conflict here and address the a11y point raised by brian and i'll try and get this tested :)

[roland-d]

@wilsonge All updated and modal title changed as well. I have kept the version number though, I do think this is useful information. As such it now looks like this:

The title is a language string now, so it can be translated as people wish.

[ciar4n]

@roland-d I created roland-d#13 which makes the modal responsive. Feel free to close if you believe it outside the scope of this PR.

[roland-d]

@ciar4n I think it looks great. Thank you.

[wilsonge]

Javascript code style issues to solve

[roland-d]

@wilsonge Yay, all green :)

[alikon]

please remove

AFTER "element" 
AFTER `infourl` 

[roland-d]

Done.

[alikon]

I have tested this item ✅ successfully on 775e102

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/24026.}

[wilsonge]

There's a test and there's a merge :) Thanks @roland-d and @NunoLopes96 for all the hard work on this!

[Quy]

@roland-d Please investigate issue #24360. Thanks.

PHP Notice: Undefined index: namespace in \libraries\src\Installer\Adapter\ComponentAdapter.php on line 1423

[hgh-esn]

@roland-d

I tested your nice extension, while working on updates to J4 for my plugin: stophitcounts.
In the plugin-manage-view I get the modal-window when clicking to the "changelog-version-item-link"

When trying to look to the changelog in the auto-updates, it fails. See

[wilsonge]

Rolands written docs for this here https://docs.joomla.org/Adding_changelog_to_your_manifest_file so removing the docs required tag