About this page: Outlines current release notes layout.
Release notes provide FOLIO libraries and hosting providers important details about a release. It allows libraries and hosting providers to prepare for migrations to FOLIO and upgrades from one release to another. Release notes provide:
- Migration instructions and details
- Release upgrade instructions and details
- Known issues
- Permissions (new and deprecated)
- Highlight new apps and/or major features
- Release presentations
Who is responsible for updating release notes? PO/Team development lead/Solution Architect are responsible for updating release notes.
Release notes are critical and should be added as soon as possible so that libraries and hosting providers have as much time as possible to review notes and prepare. Starting with Poppy, release notes deadlines have been added to release timeline. Poppy final release notes deadline is October 13 2023.
Current release notes layout
POs should
- Update release notes once a feature and/or issue is set to PO Review.
- Ask SM to coordinate time for devs to add release notes throughout the release
- If no SM, PO should remind devs to add release notes throughout the release
- Add a label to track known issues for a release
- Add a label for features/issues that require a release note
- Beaware of any updates/migrations that may result in significant service disruption or results in significant changes to data (i.e. MARC - FOLIO mapping rules changes)