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 1||Admin Helpers|
Admin helper modules are those that provide helpful tools, UI enhancements or optimizations to the admin panel (excluding Fieldtype or Inputfield modules).
|Category 2||Proof 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.
Close to stable, but users are advised to be cautious and test thoroughly.*
|Date Added||November 18, 2017|
|Last Updated||July 6, 2018|
This module's files should be placed in /site/modules/ModuleReleaseNotes/
How to install or uninstall modules
This is an auto-loading, admin-only module for ProcessWire v3+.
- Make discovery of a module's changes prior to an upgrade a trivial task.
- Make breaking changes very obvious.
- Make module authors start to think about how they can improve the change discovery process for their modules.
- Make reading of a module's support documentation post-install a trivial task.
- Make sure the display of information from the module support files/commit messages doesn't introduce a vulnerability.
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.
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.
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.
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.
Files/input is either passed through HTML Purifier (in the case of HTML-formatted files/parsed markdown) or is passedthrough
htmlspecialchars() prior to output.
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.
No comments yet. Be the first to post!
Your e-mail is kept confidential and not included with your comment. Website is optional.
- Admin Helpers
- Core Modules
- Development Tools
- Field Types
- File Validator
- Input Fields
- Language Modules
- Language Packs
- Markup Generation
- Premium Modules
- Process Modules
- Proof of Concept
- Site Profiles
- Social, Feeds, Services
- Text Formatters
- Other Modules
- Users and Access
*Use modules at your own risk. There are no guarantees or warranties. It is recommended that you backup your site and database before installing new modules.