...
...
...
...
...
...
...
...
...
...
...
...
...
...
Info |
---|
This Guideline is being drafted at the moment. Please, refrain from adding comments and questions until the draft is complete and presented for review and discussion on Tech Leads meeting. |
Action | Example | Assumptions | |
---|---|---|---|
1 | Create Versions in Jira:
| OR |
|
...
|
...
|
...
2 | I. Make sure three required Versions are created for each Jira project corresponding to the modules and other FOLIO software components (plugins, libraries, etc.) owned by a team and meaningful Version Descriptions are added:
Note: The above mentioned Versions must be increments based on the Version of the latest Quarterly Release delivered (created in GitHub). II. For a module to support updates into the last two quarterly releases |
---|
...
an additional set of |
...
versions |
...
might be required:
|
...
Note: The above mentioned Versions must be increments based on the Version of second-to-latest Quarterly Release delivered (created in GitHub). |
|
...
|
...
| |
3 | Update Fix Version field in a Story/Task/Bug selecting an appropriate Version after code changes have been merged:
There should be at least three unreleased Versions available:
If changes are implemented for second-to-latest Quarterly Release |
---|
...
, there should be corresponding unreleased Versions available (or they must be created ad-hoc):
|
...
Note: If a fix is to be backported to previous quarterly releases and delivered as Bugfix/Hotfix release, it is necessary to specify several Fix Versions to identify in which Version of every quarterly release the fix was introduced. | OR OR Patch Version (x.y.Z)
Minor Version Y (x.Y.z)
Major Version X (X.y.z)
For more details on Versioning see: Example of several Fix versions specified for an issue:
Three Fix Versions should be specified (1.5.2, 1.6.4, 2.1.1) to indicate that the fix:
|
| ||||||||||||
4 | 3 weeks prior established module release deadline Update Fix Version field in an incomplete Story/Task/Bug being not yet merged, if it is confirmed to be a release must-have item. When Fix Version added to incomplete must-have items:
|
---|
...
Note: If some incomplete item is not assigned to an appropriate Version in Jira in time, there is a great chance it won't get into Release as the team owning a module can start Release procedure earlier than the item is completed. |
|
|
5 |
---|
...
While creating a release during Release sprint I. Confirm the Version to be released and Delete unnecessary Versions: 1. if there are items |
...
in Patch Version only, Patch Version to be released: |
...
→ Patch Version is planned for release → No need to delete any Versions 2. if there are items in Minor |
...
(and |
...
Patch) |
...
Version AND no items in Major |
...
Version: → Minor Version is planned for release → |
...
Patch Version must be deleted; while deleting - all issues assigned to |
...
Patch Version must be moved to Minor |
...
Version planned for release to be included into corresponding Release notes 3. if there are items in Major Release (and Minor/ |
...
Patch) version: → Major Version is planned for release → |
...
Patch and Minor Release versions must be deleted, while deleting - all issues assigned to |
...
Patch/Minor release versions must be moved to Major Version planned for release to be included into corresponding Release notes II. Proceed with Release Procedure for a module |
...
: a. if all items assigned to a Version are |
...
completed → Proceed with Release Procedures b. if 4 days before release deadline there are still some incomplete items assigned to a Version → Proceed with Release Procedures → Incomplete items won't be included into release and Fix Version field should be cleared for them. Note: Relevant POs should be informed that release procedures are going to be started and some incomplete items should be planned for next quarterly/Bugfix/Hotfix releases. In case it is not possible to defer incomplete items to next quarterly/Bugfix/Hotfix release and the decision is to postpone release creation to get critical items completed and included, the risk of delay of a module release (and any dependent modules' releases) should be explicitly raised. Note: Before releasing - double-check if there are any items completed with Fix Version missed in Jira. If there are any - Fix versions should be added to get the items included into Release Notes in Jira. (see Template Filter → update "project" and "resolved" date |
...
(=Start date of a Version to be released) to see items |
...
Closed without Fix Version since |
...
the work on that Version had been started) | For more details on Release Procedures see: |
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
| |
6 | After Release in GitHub is created I. Release corresponding Version in Jira: 1. Release Version in Jira 2. Add Release date while releasing Version in Jira 3. Update released version description to easily identify relevance to a certain quarterly release → [QX yyyy (Hotfix/Bugfix) Release: GitHub Release URL] II. Update/add required Versions for next releases: a. if |
---|
...
Patch Version was released → Add next |
...
Patch Version → |
...
No updates for Start date for Minor and Major |
...
Versions b. if Minor Version was released: → Add next |
...
Patch and Minor |
...
Versions → Update Start date for Major |
...
Version c. if Major Version was released: → Add next |
...
Patch, Minor and Major |
...
Versions |
|
|