When a new software release is pushed to production, you might want to announce the changes to product user. This module Changelog, servers this exact purpose. Here a user can compose a change log and add what bugs were fixed, what new features were added and what code refactoring was done in this release. When published, this release works as a source of information for users and keeps them up to date on which was done recently.

Add Changelog and changelog list

  1. Since we currently has one user as of now, the admin user, A admin can compose a changelog from Create Changelog screen.
  2. The body of changelog is rich text and should support rich text formatting, image upload and gif files.
  3. Release categories are fixed which release tags are controlled from team settings page. Only those release tags are available for selection which were added in team settings.
  4. A change log can be published right now, saved as draft and can be published later or can be scheduled for release on specified release datetime.
  5. Admin can see and manage all changelogs from changelog list screen. Admin has some standard feature to manage (edit/delete/publish/archive) changelogs as well as basic filter to quickly navigate through list of changelogs.

Published changelog

  1. Every changelog when published, has a url which is public as of now and can be shared with people so that they can see details of a particular changeog. See Changelog Detail screen for more info.
  2. Every project has a url to show list of all changelogs where public can see list of all published changelogs, for example for a project named skia, this url will be release.quiclabs.in/skia/changelogs. user can scroll through the list of changelogs and filter them based on categories and tags.
  3. User can also click on one changelog to see details of that.
  4. Both these url are public and do not require any authentication to see it
  5. Both the pages are mobile responsive so that they can be consumed on any devise of any screen size.