Major release notes

From Archivematica
Jump to navigation Jump to search

Home > Release Notes > Major release notes template

Release date

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

Supported environments[edit]

Link to installation instructions.

Specify supported environments.

Make special note of any changes to supported environment.

Added[edit]

Describe new features.

New feature 1[edit]

This is a description of this amazing feature! Here's why it's a net benefit to the project and the community. Also included are any special notes, like if it's a beta feature.

This work was sponsored by some amazing institution. Thank you!

  • Documentation: link
  • Pull requests: link

New feature 2[edit]

Here is a description of this amazing feature! Here's why it's a net benefit to the project and the community, and here is how it will impact your workflow. Also included are any special notes, like if it's a beta feature.

This work was sponsored by some amazing institution. Thank you!

  • Documentation: link
  • Pull requests: link
  • Feature files: link

Changed[edit]

Describe enhancements or major fixes.

Enhancement 1[edit]

We fixed this issue. Here's why it's a net benefit to the project and the community, and here is how it will impact your workflow. Also included are any special notes, like if it's a beta feature.

This work was sponsored by some amazing institution. Thank you!

  • Documentation: link
  • Pull requests: link
  • Feature files: link

Fixed[edit]

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[edit]

List any tools and dependencies that have been upgraded.

  • Tool has been updated to version X.

End of life dependencies[edit]

List any dependencies that have reached end of life since the last release, as well as a note on the plan going forward.

Make note of any risks, and how users can mitigate them.