Checklist
GitHub
...
Release Management
- Neccessary steps for “Release Management” are documented and up-to-date (deliverables, pull-requests, update release documentation, update architecture documentation, update sandbox landscape)
- All affected repositories (GitHub, Pypi.org, http://npmjs.com , etc.) are tagged and versioned according to Version management
Releases Page -> Releases
- All links are working and are helpful
- Dates and status of all releases are correct
Release Page: e.g. Release 2022-04
- All links are working and are helpful
- Release is marked as “GA” and dates are correct
- All relevant tickets are assigned
- All assigned tickets are marked “Done”
Release Sources Page: e.g. Sources Release 2022-04
- All components are consistently versioned according to Version management
- All links are working and helpful
- All components link to the correct repository and version
- All components have correct “Release Notes”
- All components link to reasonably similiar named repositories / package manager
Release notes and Sub Pages
- Release notes Shows the latest release notes of all sub pages
- All sub pages of Release notes contain the same release notes of the latest version as the repository (at the time of the release)
User Documentation
- User Documentation is up-to-date http://docs.openimis.org/en/latest/ / http://docs.openimis.org/fr/latest/
Installation guide / Configuration / Other
- Installation guide / Installation and Country Localisation supports installation of the latest release
- Developer Starter Kit reflects latest release
- “Technical Requirements” / Connectivity & theoretical infrastructure required reflects lastest release
- Tutorials on YouTube are up-to-date / not misleading
Sandbox Landscape
- Demo: openIMIS Instance and Wiki page are up to date
- Release: openIMIS Instance and Wiki page are up to date
- Sandbox Landscape Other instances are up to date / compatible with Demo: openIMIS / Release: openIMIS
Following Release
- Release Page (e.g. Release 2022-04) for the following release is set up and appears correctly on Releases
Findings Release 2022-04
- Release 2022-04 Status is not “GA”
- Releases Status of Release 2022-04 is not “GA”
- Release 2022-04 List of assigned tickets seems to be incomplete (Huge changelog for Legacy Web App, but empty list of tickets!?)
- Release 2022-04 Some assigned tickets are not “Done”
- Release 2022-04 Link to “Release Notes” is broken
- Sources Release 2022-04 Chapter General/Intro: Most links are broken or not helpful
- Sources Release 2022-04 Chapter “Database”: Link “Installation guide” is broken
- Sources Release 2022-04 Chapter “Docker scripts”: Links for “Installation guide” and “Dependencies” are broken
- Sources Release 2022-04 Some version numbers have 4 digits, others 3
- Sources Release 2022-04 Some version numbers have “rc..”, “April” and so on in their names
- Sources Release 2022-04 “Installation guide” links in “openIMIS modular version - Docker scripts” are broken
- Sources Release 2022-04 Double “BE Claim AI module”
- Sources Release 2022-04 “FE French Translations module” - Missing “Release Notes”
- Sources Release 2022-04 “FE Claim Batch module” - Missing “Release Notes”
- Sources Release 2022-04 “FE French Translations module” - Mismatch between name of module and name of repository / Mismatch between “Version” and “Repository” (wrong repo “openimis-fe-tools.js” ?)
- Sources Release 2022-04 Most (all?) dependency links are broken
- Sources Release 2022-04 Most (all?) links to installation guides are broken
- Sources Release 2022-04 Link to ”Backend installation guide” is broken
- Sources Release 2022-04 Link to “Frontend installation guide” is missing
- Sources Release 2022-04 Some components don’t link to the “latest” on GitHub (e.g. Claims mobile application)
- Release notes Warns about an old release → Release 2021-04
- Sources Release 2022-04 Does not link to the latest version according to openIMIS Frontend assembly release notes and GitHub
- Sources Release 2022-04 “BE Calcrule Contribution Legacy module” does not link to a version
- openIMIS BE Calcrule Contribution Legacy module release notes does not link to a version
- Sources Release 2022-04 “BE Calcrule Capitation Payment module” does not link to a version
- openIMIS BE Calcrule Capitation Payment module release notes does not link to a version
- Sources Release 2022-04 “BE Tools module” does not link to a version
- openIMIS BE Calcrule Capitation Payment module release notes does not link to a version
- Sources Release 2022-04 “Frontend assembly” points to an old version
- Sources Release 2022-04 “FE French Translations module” points to an old version but names a new version
- openIMIS FE Home module release notes Is not up2date
- Sources Release 2022-04 “FE Claim Batch module” points to an old version
- openIMIS Policies Mobile Application release notes is not up2date
- Sources Release 2022-04 “Policies mobile application” points to an old version
- Sources Release 2022-04 “Claims mobile application” points to an old version
- openIMIS Claims Mobile Application release notes is not up2date
- Sources Release 2022-04 All BE modules point to http://pypi.org except “Backend assembly”, “BE Calcrule Contribution Legacy module”, “BE Calcrule Capitation Payment module“, “BE Tools module”
Questions
- How do we keep the version (link) of every component in Sources Release 2022-04 in sync with every component component’s “Release notes” page (e.g. openIMIS Database release notes) as well as with what is actually in the repository?
Future Improvements
- Dedicated page for each module under openIMIS Modules (with Page Properties, descriptions/basic explaination, version history - Based on release notes pages?)
- Include repository info instead of redundancy (and info gaps) between Release notes and repositories on GitHub (PlugIn?)
- Clarify usage of Pypi.org and npmjs.org with GitHub (calcrule links to GitHub, others to PyPi)
- Update Installation Guides
- Dependency Graph for modules / consistent dependency information in Sources Release 2022-04
- Reevaluate “Testing openIMIS” on Sources Release 2022-04
- Consider “Legacy” modules as “Deprecated” on Sources Release 2022-04
- Sort components by name on Sources Release 2022-04?
- Release 2022-04 Reevaluate redundant information in “Highlights” and “Release Notes”
- Combine Releases / Release 2022-04 , Release notes and Sources/Sources Release 2022-04 to reduce structural redunancy and confusion
...