User tests: Successful: Unsuccessful:
This is a continuation of issue #17536 as I can no longer push to that repo, starting a new PR.
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.
Added a new parameter on the xml updateserver files 'changelogurl' and adding it to #__updates table.
npm ci
to compile the JavaScriptList of Students
0.0.2
Manage View
Update View
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:
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.
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.
Add changelogurl parameter on updatesite information and in extension.
Add changelog XML format to updatesite information
Status | New | ⇒ | Pending |
Category | ⇒ | SQL Administration com_admin Postgresql com_installer Language & Strings Installation Libraries |
Labels |
Added:
?
?
|
What you had in #17536 (comment) looks OK to me.
@roland-d I'm been hit with he following when attempting to find updates...
Update: Could not open update site #4 "My Extension's Updates", URL: https://www.jah-tz.de/downloads/core/gsoc17/extension.xml
I'm only noticing you tagged me in the original PR. Still looking for help on some styling?
Category | SQL Administration com_admin Postgresql com_installer Language & Strings Installation Libraries | ⇒ | SQL Administration com_admin Postgresql com_installer Language & Strings Installation Layout Libraries |
Category | SQL Administration com_admin Postgresql com_installer Language & Strings Installation Libraries Layout | ⇒ | SQL Administration com_admin Postgresql com_installer Language & Strings JavaScript Repository NPM Change Installation Layout Libraries |
Labels |
Added:
NPM Resource Changed
|
Sure. Give me a couple days and i will take a look!
Category | SQL Administration com_admin Postgresql com_installer Language & Strings Installation Libraries Layout JavaScript Repository NPM Change | ⇒ | SQL Administration com_admin Postgresql com_installer Language & Strings Templates (admin) JavaScript Repository NPM Change Installation Layout Libraries |
There is desire! I'm trying to merge quite a lot of 3.9.0 into the 4.0 branch over the next few nights as my girlfriend is out the country. please don't hesitate to ping me after the weekend is over to come back to this!
@mbabker if you could confirm the xml schema changes you were after had been made it would save me from doing so much code review
Also a testable component here would be ideal - appreciate providing a sample component is hard - but i'm really trying not introduce anymore broken features in the 4.0 branch. More than happy to be the one that actually does the testing however if no one steps up
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
@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.
Javascript code style issues to solve
I have tested this item
Status | Pending | ⇒ | Fixed in Code Base |
Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2019-03-25 11:29:02 |
Closed_By | ⇒ | wilsonge |
There's a test and there's a merge :) Thanks @roland-d and @NunoLopes96 for all the hard work on this!
Rolands written docs for this here https://docs.joomla.org/Adding_changelog_to_your_manifest_file so removing the docs required tag
I still think this is best suited as an XML schema that is parsed into the modal instead of iframing an external page in (#17536 (comment)).