About Release Notes Discovery Module

Makes discovery of a module's changes, prior to upgrade, a trivial task. Makes support documentation accessible from the admin interface.

Category 1Admin Helpers
Admin helper modules are those that provide helpful tools, UI enhancements or optimizations to the admin panel (excluding Fieldtype or Inputfield modules).
Category 2Proof of Concept
Proof of concept modules are designed as examples or starting points for others to build from. May not be ideal for users wanting to plug-n-play.
Release StateBeta
Close to stable, but users are advised to be cautious and test thoroughly.*
Authornetcarver
Module Version0.10.2
Class NameModuleReleaseNotes
Compatibility3.0
Date AddedNovember 18, 2017
Last UpdatedDecember 2, 2017
Recommended ByNew recommendations may take up to 1 day to appear.

Instructions

This module's files should be placed in /site/modules/ModuleReleaseNotes/
How to install or uninstall modules

README

Notes About The ModuleReleaseNotes Module

This is an auto-loading, admin-only module for ProcessWire v3+.

Aims

  1. Make discovery of a module's changes prior to an upgrade a trivial task.
  2. Make breaking changes very obvious.
  3. Make module authors start to think about how they can improve the change discovery process for their modules.
  4. Make reading of a module's support documentation post-install a trivial task.
  5. Make sure the display of information from the module support files/commit messages doesn't introduce a vulnerability.

Making Discovery Of Changes Easy Prior To Upgrade

A "What's Changed" section is added to the Module Update Confirmation Dialog that lists any Github Release Notes for thenew version (along with all the commits pushed between the currently installed version and the available version) or the contents of the project's CHANGELOG.md file (if any) or simply a list of the last commits if the above are not available.

In the case of a changelog display, attempts are made to highlight the currently installed version and the latestversion, with focus being given to all the changes between the two.

Making Breaking Changes Obvious

The module includes a very rudimentary method of checking for breaking changes - it simply searches for one of a set ofconfigurable strings that could indicate a breaking change. If there is a match found, the changelog display styles are updated to make this obvious.

It may be possible, at a later date, to support other breaking-change signalling schemes, but this will do as a startingpoint.

Getting Module Authors to Think About The Process Of Change Discovery

As part of the update confirmation dialog, details are shown of how authors can improve the change discovery process forthe module users. This module does not intend to dictate any particular method - that's up to module authors and why this module supports multiple different methods for showing changes.

Making Reading Of Support Files Easy

As well as supporting the discovery of changes prior to upgrade, the module makes the support files that normallyaccompany a module readable from the Module's information page in the admin interface. Each file starting with README, CHANGELOG and LICENSE can be displayed and browsed.

Staying Safe

Files/input is either passed through HTML Purifier (in the case of HTML-formatted files/parsed markdown) or is passedthrough htmlspecialchars() prior to output.

Supported Code Hosts

ModuleReleaseNotes needs to be able to ask remotely hosted code repositories about what's changed for a module. As mostpeople push their code up to Github, that's where I started. The module knows how to talk to github using the v3 rest API, but it isn't a pretty picture - yet.

Comments

No comments yet. Be the first to post!

Post a Comment

Your e-mail is kept confidential and not included with your comment. Website is optional.