Difference between revisions of "Minor release notes"

From Archivematica
Jump to navigation Jump to search
Line 1: Line 1:
 
[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Minor release notes template
 
[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Minor release notes template
  
−
'''IMPORTANT''': only link to Redmine tickets in the public [https://projects.artefactual.com/projects/archivematica?jump=welcome| Archivematica project]. If no public ticket exists, create a new ticket in the public Archivematica project and link it to the corresponding private ticket.
+
In the header, include any general notes about the release. For an example, see the [[Archivematica_1.6_release_notes|Archivematica 1.6 Release Notes]].
  
−
  In the header, indicate the purpose for the point release (bug fixes, security patch,
+
  Generally speaking, point releases should not include new features or enhancements,  
−
  packaging) and the release date.
+
  just fixes and maybe upgraded tools/dependencies.  
  
−
Type of release - MM DD, YYYY.
+
==Supported environments==
  
−
===Archivematica #.#.#===
+
Link to installation instructions.
  
−
For each project, list bug fixes/enhancements/patches and link to the Redmine ticket
+
Specify supported environments, especially if the point release includes new packages.
−
and/or Github pull request. If it's a big point release, you may want to break down
 
−
the projects into sections, as in a major release.
 
  
−
For sponsored features, enhancements, or bug fixes (including those done on support
+
Make special note of any changes to supported environment.
−
tickets), follow the '''Sponsored''' syntax as in a major release.
 
  
−
* Short description of fix - Link to Redmine ticket
+
==Fixed==
−
* Archivematica and Storage Service packaged for CentOS - [https://projects.artefactual.com/issues/10129| #10129]
 
  
−
===Storage Service #.#===
+
List bugfixes with a link to the Github issue.
  
−
* '''Sponsored''' (MoMA) Enhanced download from Arkivum - [https://projects.artefactual.com/issues/9840| #9840]
+
* Bugfix 1: link
 +
* Bugfix 2: link. Sponsored by someone!
 +
* Bugfix 3: link
 +
 
 +
==Upgraded tools and dependencies==
 +
 
 +
List any tools and dependencies that have been upgraded.
 +
 
 +
* Tool has been updated to version X.

Revision as of 13:15, 3 May 2018

Home > Release Notes > Minor release notes template

In the header, include any general notes about the release. For an example, see the Archivematica 1.6 Release Notes. 

Generally speaking, point releases should not include new features or enhancements, 
just fixes and maybe upgraded tools/dependencies.

Supported environments

Link to installation instructions.

Specify supported environments, especially if the point release includes new packages.

Make special note of any changes to supported environment.

Fixed

List bugfixes with a link to the Github issue.

  • Bugfix 1: link
  • Bugfix 2: link. Sponsored by someone!
  • Bugfix 3: link

Upgraded tools and dependencies

List any tools and dependencies that have been upgraded.

  • Tool has been updated to version X.
Retrieved from "https://wiki.archivematica.org/index.php?title=Minor_release_notes&oldid=12466"