2021 R1 Iris PO Bugfix and Hotfix Release Process:

Owned by Kelly Drake
Last updated: Jun 21, 2021 by Ann-Marie Breaux (Deactivated)
5 min read

Bugfix = a fix release that happens after the module release deadline, but before the actual release

Hotfix = a fix release that happens after the final flower release, and heads straight to production

This describes the R1 2021 (Iris) Hotfix release process. This will be adjusted for future quarterly releases. (Prior quarters' Bugfix/Hotfix procedures are saved as child pages).

  1. Hotfix release = one that must be added to a release after the final release has been made. 
  2. According to the soon-to-be-approved release process, we won't create a hotfix release except for P1 functional and P2 security issues.  Once a hotfix release has been scheduled, lower priority issues (e.g. P2 and P3 functional issues) may also be included with permission.
  3. For R1 2021 hotfixes, set Release field of the bug Jira issues to R1 2021 Hot Fix<Number> and make sure the developers doing the fix know that it is needed for a hotfix
  4. Get the issue fixed and test on https://folio-snapshot.dev.folio.org/
  5. Any hot fix issue should be approved:
    1. Once the fix has passed testing in snapshot, post the Jira and seek approval for a hotfix release on the Slack #release_bug_triage channel. Approvers are Kelly Drake, Mike Gorrell, Harry Kaplanian, Holly Mistlebauer, Jakub Skoczen and Mark Veksler.  Please tag the approvers with your request (can be considered approved if you get the thumbs up from at least two technical approvers (Mike, Mark or Jakub))
  6. If approved, ask the module maintainer to create a hotfix release and set the JIRA status to Awaiting release.
    1. You can get the module maintainer’s name from the Team Module Responsibility Matrix.
    2. The release needs to go to the appropriate Release branch and the Main branch. 
    3. The release Jira should be linked to the appropriate R1 2021 Hotfix epic, currently FOLREL-457
    4. When the release is made, the module maintainer will announce it on the Slack #releases channel. 
    1. The module maintainer will change the bug issue's status to Awaiting deployment. There is no need for the PO or module maintainer to request that the release be deployed
    2. Jenkins robot automatically generate pull request for the "R1 2021" branch of Platform Complete repository in Github for every released module if version incremented by "patch" number. (For example from 1.1.1 to 1.1.2)
    3. Manual intervention required if release version requires change of major ( 1.1.1 to  2.0.0) or minor (1.1.1 to 1.2.0) number. In this case PO or Dev lead  have to notify DevOps and Anton Emelianov (Deactivated) about this change.
    4. Folio hosting team checks for updates of Platform Complete one time per day and updates Bug Fest system with modules that have been released since yesterday's update.
    5. Folio hosting team will post notification in #bug-fest Slack channel when update starts and ends. 
    6. Once daily update has been deployed to Bug Fest, Anton Emelianov (Deactivated) will change the bug issue's status to In bugfix review which is the PO's trigger to do the final round of testing in the Bug Fest environment
    7. Finally, when the issue has passed test in the Bug Fest environment, the PO should change the status to Closed . When the release is made, the module maintainer will announce it on the Slack #releases channel and change the JIRA status to Awaiting deployment 
  7. Add information about the hotfix to the R1/Iris Release Notes page on the wiki, in the Post-release Hotfixes table: TBD
  8. Once the hotfix has passed testing on BugFest, it needs to be deployed to libraries using the current release in production or in sandbox.
    1. For EBSCO-hosted libraries, ask an EBSCO PO or Anton to deploy the fix.
    2. For Index Data-hosted libraries, Wayne Schneider is managing the deployments. 
    3. Self-hosted libraries will need to decide whether to implement the hotfix or not, based on the announcement on the Slack releases channel or the release notes.
  9. If hotfixes are deployed by hosting providers, they should notify the libraries using the current release in production or sandbox that a hotfix has been deployed

This describes the R1 2021/Iris Bugfix release process (fixes being released after the initial release, but before the final Iris deadline). This will be adjusted for future releases

  1. Bugfix = fix that happens after the module release deadline, but before the actual release. Iris Release Schedule Most of these issues will be identified during BugFest R1 2021 Iris BugFest
  2. Set Release field of the bug Jira issues to R1 2021 Bug Fix and let the developers doing the fix know that it is needed ASAP for a bugfix, definitely before the Juniper release. Do not confuse with the Fix version field, which should reflect the release version the fix will be included in.
  3. Label the bug Jira issues with bugfest_r1.2021 if the bug is found by a community tester during BugFest (this allows us to keep statistics on the bugs produced during that process. Don't forget to link Jira issue to TestRail test case.
  4. Use label regression when applicable
  5. Get the issue fixed and test on https://folio-snapshot.dev.folio.org/ (if possible - some performance issues that don't repro on snapshot will have to skip snapshot testing and be tested on the Bug Fest environment, instead)
  6. No permission is required for bugfixes before the release deadline. Once the fix has passed testing in snapshot, change the status to the "Awaiting release" and ask the module maintainer to create a bugfix release.
    1. You can get the module maintainer’s name from the Team Module Responsibility Matrix.
    2. The release needs to go to the appropriate Release branch and the Main branch. 
    3. When the release is made, the module maintainer will announce it on the Slack #releases channel. 
  7. Create a release ticket for the module and assign Bugfix Epic   FOLREL-456 - Getting issue details... STATUS  . Be sure that each bug in the release has the correct release version assigned to it.
  8. When the release has been created
  9. Change the status of the release ticket to Closed
  10. The module maintainer will change the bug issue's status to Awaiting deployment. There is no need for the PO or module maintainer to request that the release be deployed
  11. Jenkins robot automatically generate pull request for the "R1 2021" branch of Platform Complete repository in Github for every released module if version incremented by "patch" number. (For example from 1.1.1 to 1.1.2)
  12. Manual intervention required if release version requires change of major ( 1.1.1 to  2.0.0) or minor (1.1.1 to 1.2.0) number. In this case PO or Dev lead  have to notify DevOps and Anton Emelianov (Deactivated) about this change.
  13. Folio hosting team checks for updates of Platform Complete one time per day and updates Bug Fest system with modules that have been released since yesterday's update.
  14. Folio hosting team will post notification in #bug-fest Slack channel when update starts and ends. 
  15. Once daily update has been deployed to Bug Fest, Anton Emelianov (Deactivated) will change the bug issue's status to In bugfix review which is the PO's trigger to do the final round of testing in the Bug Fest environment
  16. Finally, when the issue has passed test in the Bug Fest environment, the PO should change the status to Closed