| Joey Armstrong | 3980d70 | 2023-08-23 10:57:18 -0400 | [diff] [blame] | 1 | Jira tickets for code changes |
| 2 | ============================= |
| 3 | |
| 4 | Please open a `jira ticket <https://jira.opencord.org/projects/VOL>`_ describing the issue/feature. |
| 5 | |
| 6 | - For large or multi-part features create a containing ticket with several |
| 7 | sub-tickets tracking individual features or problems. |
| Joey Armstrong | 704dd6d | 2023-08-24 08:01:47 -0400 | [diff] [blame] | 8 | |
| Joey Armstrong | 864db88 | 2023-08-24 15:01:35 -0400 | [diff] [blame] | 9 | .. list-table:: Multi-part ticket with subtask |
| 10 | :widths: 10, 10, 40 |
| 11 | :header-rows: 1 |
| Joey Armstrong | 704dd6d | 2023-08-24 08:01:47 -0400 | [diff] [blame] | 12 | |
| Joey Armstrong | 864db88 | 2023-08-24 15:01:35 -0400 | [diff] [blame] | 13 | * - Jira |
| 14 | - Type |
| 15 | - Problem |
| 16 | * - `VOL-5125 <https://jira.opencord.org/browse/VOL-5125>`_ |
| 17 | - Epic |
| 18 | - Tracking ticket for bbsim failures in jenkins vip job view. |
| 19 | * - `VOL-5024 <https://jira.opencord.org/browse/VOL-5024>`_ |
| 20 | - sub-task |
| 21 | - bbsim unit test job reporting status=UNSTABLE |
| 22 | * - `VOL-5157 <https://jira.opencord.org/browse/VOL-5157>`_ |
| 23 | - sub-task |
| 24 | - verify_bbsim_unit-test failures in history |
| 25 | * - `VOL-5154 <https://jira.opencord.org/browse/VOL-5154>`_ |
| 26 | - sub-task |
| 27 | - Triage test failure in periodic-voltha-unitag-subscriber-tt-test-bbsim |
| Joey Armstrong | 704dd6d | 2023-08-24 08:01:47 -0400 | [diff] [blame] | 28 | |
| 29 | - Description - include relevant information |
| Joey Armstrong | 3980d70 | 2023-08-23 10:57:18 -0400 | [diff] [blame] | 30 | |
| 31 | - Error messages |
| Joey Armstrong | 864db88 | 2023-08-24 15:01:35 -0400 | [diff] [blame] | 32 | |
| 33 | - Use preformatting to improve readability (else message becomes a run-on sentence). |
| 34 | - In ticket description click plus icon on the right side. |
| 35 | - Select preformatted |
| 36 | - Copy and patest text into the preformatted box to retain structure. |
| 37 | |
| Joey Armstrong | 3980d70 | 2023-08-23 10:57:18 -0400 | [diff] [blame] | 38 | - Reproduction step(s) for problems |
| 39 | - Web URLs, links to jenkins job logs are very helpful. |
| 40 | |
| 41 | - Note: Jenkins job logs will age out and disappear over time. |
| 42 | - To prevent this view the job history panel in jenkins UI |
| 43 | |
| Joey Armstrong | 704dd6d | 2023-08-24 08:01:47 -0400 | [diff] [blame] | 44 | - `View a jenkins job page <https://jenkins.opencord.org/view/vip/job/verify_bbsim_unit-test>`_ |
| 45 | - Two links are available in history (lower left corner), colored icon on the left and #job on the right. |
| Joey Armstrong | 3980d70 | 2023-08-23 10:57:18 -0400 | [diff] [blame] | 46 | - Click the #job link to view job. |
| 47 | - Top right corner will contain a clickable button "Keep this build forever". |
| Joey Armstrong | 704dd6d | 2023-08-24 08:01:47 -0400 | [diff] [blame] | 48 | - At some point in the future after a ticket has been resolved |
| 49 | remember to revisit the job log and unfreeze it (click button: |
| 50 | Do not keep this build forever) |
| Joey Armstrong | 3980d70 | 2023-08-23 10:57:18 -0400 | [diff] [blame] | 51 | |
| 52 | - Assign field ``Fix Version/s:`` VOLTHA-X.Y |
| 53 | |
| 54 | - This will enables searching for feature by release. |
| 55 | - Leveraged during release to document fixes and enhancements in release notes. |
| 56 | - While viewing a jira ticket, the 'More' navigation pulldown menu at the top |
| 57 | is useful for creating sub tickets or creating links to external resources. |
| 58 | |
| 59 | See Also |
| 60 | -------- |
| 61 | |
| 62 | - https://jira.opencord.org |
| 63 | - `jira :: VOLTHA <https://jira.opencord.org/projects/VOL/issues/VOL-4470?filter=allopenissuse>`_ |