[4.0] Show changelog - GSoC Expand Extensions Manager by NunoLopesPT · Pull Request #17536 · joomla/joomla-cms

NunoLopesPT · 2017-08-14T15:43:33Z

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

I made some changes in the core databases so before testing you should fix your database:

Extensions -> Database -> Fix
Extensions -> Updates -> Find Updates

Update View

Install my component: https://github.com/NunoLopes96/component_joomla
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 with an iframe of the changelogurl in the body.
The title of the modal is version ' - ' component_name

Manage View

The changelogurl is supported for Components, Libraries, Modules, Plugins and Packages, you just need to add tags in your instalation xml with a valid url inside.

To test this you can use these modified packages:

(To test Package, Component, Module, Plugin)
pkg_weblinks_3.4.1-changelog.zip

(To test Libraries)
lib_fof30-3.1.0-changelog.zip

(To test languages)
The language installer its diferent from the others so you may want to test 2 cases:
1-Install without having it already in your extensions
2-Install without changelogurl and then install again with a changelogurl

This happens because it has 1 function to install and another one to update ( they are similar )

admin_pt-PT.zip
Extension name: Português (pt-PT)

(To test templates)
et_kidtoy_joomla_template_install_package_free.zip
Extension name: etkidtoy

(To test Files)
cli2zoombie.zip
Extension name: Zoombie - CLI Application

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

…7_expand_extension_manager into show_changelog

…pand_extension_manager into show_changelog

…file

…pand_extension_manager into show_changelog

…_extension_manager into show_changelog

…7_expand_extension_manager into show_changelog

…_extension_manager into show_changelog

roland-d · 2018-07-01T21:05:24Z

I have started to bring this PR inline with the 4.0-dev codebase and work out the issues and improve the featureset.

I am sure @Quy will help me with codestyle :) Now I also need help with styling the modal containing the updates. Have a look at this:

This contains all the possible sections that are available. @ciar4n is this something you can help me with?

As for the changelog.xml I am now using this format, any feedback for this is appreciated as well.

<?xml version="1.0" encoding="utf-8"?>
<changelogs>
    <changelog>
        <element>com_lists</element>
        <type>component</type>
        <version>0.0.4</version>
	<entries>
        <security>
            <item>CVE 1</item>
            <item>CVE 2</item>
        </security>
        <fix>
            <item>FIX 1</item>
            <item>FIX 2</item>
        </fix>
        <language>
            <item>LANG 1</item>
            <item>LANG 2</item>
        </language>
        <addition>
            <item>ADD 1</item>
            <item>ADD 2</item>
        </addition>
        <change>
            <item>CHANGE 1</item>
            <item>CHANGE 2</item>
        </change>
        <removed>
            <item>REMOVE 1</item>
            <item>REMOVE 2</item>
        </removed>
        <note>
            <item>NOTE 1</item>
            <item>NOTE 2</item>
        </note>
</entries>
    </changelog>
</changelogs>

This PR is not ready yet but I would appreciate feedback already so we can get this into a ready state.

brianteeman · 2018-07-01T21:14:44Z

administrator/language/en-GB/en-GB.com_installer.ini

+COM_INSTALLER_CHANGELOG="Changelog"
+COM_INSTALLER_CHANGELOG_SECURITY="Security Fixes"
+COM_INSTALLER_CHANGELOG_FIX="Bug Fixes"
+COM_INSTALLER_CHANGELOG_LANGUAGE="Changelog"


why is this _LANGUAGE ?? or is it the "Changelog" that is wrong?

It is actually "Changelog" that is wrong. This needs to be "Language" as it is about language file changes listed in the changelog.

brianteeman · 2018-07-01T21:17:58Z

libraries/src/Installer/Adapter/ModuleAdapter.php

 			catch (\RuntimeException $e)
 			{
-				\JLog::add(\JText::sprintf('JLIB_INSTALLER_ERROR_MOD_UNINSTALL_EXCEPTION', $e->getMessage()), \JLog::WARNING, 'jerror');
+				\JLog::add(Text::sprintf('JLIB_INSTALLER_ERROR_MOD_UNINSTALL_EXCEPTION', $e->getMessage()), \JLog::WARNING, 'jerror');


please namespacce JLog

+use Joomla\CMS\Log\Log;

Quy · 2018-07-02T15:06:11Z

administrator/components/com_installer/tmpl/update/default.php

-								</td>
-							</tr>
+								<tr>
+									<td colspan="9">


Change to 10

Quy · 2018-07-02T15:06:54Z

administrator/language/en-GB/en-GB.com_installer.ini

 COM_INSTALLER="Installer"
 COM_INSTALLER_AUTHOR_INFORMATION="Author Information"
 COM_INSTALLER_CACHETIMEOUT_LABEL="Updates Caching (in hours)"
+COM_INSTALLER_CHANGELOG="Changelog"


Sort keys in alpha order

@Quy What is not sorted here? CA is before CH.

Sort keys from lines 10 - 16.

Quy · 2018-07-02T15:17:56Z

libraries/src/Installer/Adapter/LanguageAdapter.php

 		{
 			return true;
 		}
 		else


No need to be in else statement.

Quy · 2018-07-02T15:23:25Z

administrator/components/com_installer/tmpl/manage/default.php

+										<?php echo $item->type_translated; ?>
+									</td>
+									<td class="d-none d-md-table-cell text-center">
+										<?php if ($item->version != ''): ?>


Add space before :

Quy · 2018-07-02T15:23:40Z

administrator/components/com_installer/tmpl/manage/default.php

+									</td>
+									<td class="d-none d-md-table-cell text-center">
+										<?php if ($item->version != ''): ?>
+											<?php if ($item->changelogurl != null): ?>


Add space before :

Quy · 2018-07-02T15:24:16Z

administrator/components/com_installer/tmpl/update/default.php

+											<span class="badge badge-success"><?php echo $item->version; ?></span>
+										</td>
+										<td class="d-none d-md-table-cell text-center">
+											<?php if ($item->changelogurl != null):?>


Add space before and after :

Quy · 2018-07-02T15:24:43Z

administrator/components/com_installer/tmpl/update/default.php

+												'<iframe src="' . $item->changelogurl . '"></iframe>');
+											?>
+
+											<?php else:?>


Add space before and after :

Quy · 2018-07-02T15:25:04Z

administrator/components/com_installer/tmpl/update/default.php

+
+											<?php else:?>
+											<span>
+												<?php echo Text::_('COM_INSTALLER_TYPE_NONAPPLICABLE')?>


Add ; and space

wilsonge · 2018-07-02T23:57:28Z

I don't think you need the type in your schema. This living on a foreign server where you are already matching against the element so I don't see what value it's providing?

Additionally I think we only need fix and note - not change - they should be covered by the other things

roland-d · 2018-07-03T20:44:34Z

@wilsonge The reason the type is there is because we have it that way in the update XMLs as well. The only reason I took it as well is because I figured we can use it for better checking we have the correct type.

Additionally I think we only need fix and note - not change - they should be covered by the other things

As an extension developer I use all of them to clearly identify where the entry belongs to. Each has their own merit to me at least. I don't see any harm in offering them, extension developers don't have to use them of course. They are there for those who want to use more distinction.

brianteeman · 2018-07-03T21:10:58Z

Agree with roland - hardly changelog without listing any changes ;)

roland-d · 2019-02-26T19:49:42Z

Closing this as I can't push to the repo anymore. Continuing in #24026

…4026) Thanks to @NunoLopes96 for the majority of the work on this!

NunoLopesPT and others added 30 commits May 17, 2017 15:02

Add new parameter to XML files changelogurl

14a6cba

Modal on Update view using the changelogurl

4a5a587

CodeStyle

9a05cee

Merge branch 'show_changelog' of https://github.com/NunoLopes96/gsoc1…

eaa19cd

…7_expand_extension_manager into show_changelog

Added new column on Update view / button changelog / codestyle changes

8f7c94d

Null to lower case

e5907c6

Merge branch 'master' of https://github.com/joomla-projects/gsoc17_ex…

bbfc298

…pand_extension_manager into show_changelog

Merge branch 'master' of https://github.com/joomla-projects/gsoc17_ex…

b83f010

…pand_extension_manager into show_changelog

Added changelog modal in the manage view and bug fix

016d4c0

NL

6d1453a

Read changelogurl parameter of an extensions in the xml installation …

3762575

…file

codestyle

65fea02

Added feature to Libraries / Modules / Packages and Plugins

ac1d41d

Added Language changelogurl in install and update

b3d9a98

Changelog to Templates added

a75ab12

added changelog url to Files

417b5f9

Merge branch 'master' of https://github.com/joomla-projects/gsoc17_ex…

d702a54

…pand_extension_manager into show_changelog

Merge branch 'master' of https://github.com/joomla-projects/gsoc17_ex…

04b2a45

…pand_extension_manager into show_changelog

Merge branch 'master' of https://github.com/NunoLopes96/gsoc17_expand…

fa7126a

…_extension_manager into show_changelog

Codestyle

ad91562

Added namespaces and replaced Jhtml for JHtml

69e9576

Merge branch 'master' of https://github.com/NunoLopes96/gsoc17_expand…

abe632f

…_extension_manager into show_changelog

Merge branch 'show_changelog' of https://github.com/NunoLopes96/gsoc1…

1b8450d

…7_expand_extension_manager into show_changelog

Update files merged

4119c94

Update default.php

cc525be

Update default.php

16d7a3e

Update default.php

62be1da

Merge branch 'master' of https://github.com/NunoLopes96/gsoc17_expand…

65b854b

…_extension_manager into show_changelog

Code style

5380927

Code style

775e102

roland-d added 3 commits June 10, 2018 08:14

Work on changelog layout

5c1d96d

Merge branch '4.0-dev' into show_changelog

d94c8a0

Start code cleanup

79497a8

NunoLopesPT requested review from mbabker, rdeutz, wilsonge and zero-24 as code owners July 1, 2018 20:59

brianteeman reviewed Jul 1, 2018

View reviewed changes

roland-d added 2 commits July 2, 2018 08:39

Use namespaced Log

f457496

Fix language entry

b934fa7

Quy reviewed Jul 2, 2018

View reviewed changes

administrator/components/com_installer/tmpl/update/default.php Outdated

</td>

</tr>

<tr>

<td colspan="9">

Copy link

Contributor

Quy Jul 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change to 10

Quy reviewed Jul 2, 2018

View reviewed changes

libraries/src/Installer/Adapter/LanguageAdapter.php Outdated

{

return true;

}

else

Copy link

Contributor

Quy Jul 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to be in else statement.

Quy reviewed Jul 2, 2018

View reviewed changes

roland-d added 2 commits July 2, 2018 19:07

Code style fixes

541e07e

Merge branch '4.0-dev' into show_changelog

9680550

Merge branch '4.0-dev' into show_changelog

f8e5afc

roland-d mentioned this pull request Feb 26, 2019

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

Merged

roland-d closed this Feb 26, 2019

wilsonge pushed a commit that referenced this pull request Mar 25, 2019

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

48af582

…4026) Thanks to @NunoLopes96 for the majority of the work on this!

Uh oh!

Comments

Conversation

NunoLopesPT commented Aug 14, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Introduction

Summary of Changes

Testing Instructions

Expected result

Documentation Changes Required

Uh oh!

roland-d commented Jul 1, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wilsonge commented Jul 2, 2018

Uh oh!

roland-d commented Jul 3, 2018

Uh oh!

brianteeman commented Jul 3, 2018

Uh oh!

roland-d commented Feb 26, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

NunoLopesPT commented Aug 14, 2017 •

edited

Loading