| Joey Armstrong | 56334fc | 2023-01-15 22:53:19 -0500 | [diff] [blame] | 1 | VOLTHA Components: voltha-protos |
| 2 | ================================ |
| 3 | |
| 4 | Dependencies |
| 5 | ------------ |
| 6 | |
| 7 | - google-api library version |
| 8 | |
| 9 | Validate |
| 10 | -------- |
| 11 | |
| Joey Armstrong | 018aa3d | 2024-01-02 21:40:15 -0500 | [diff] [blame] | 12 | - make help |
| Joey Armstrong | 56334fc | 2023-01-15 22:53:19 -0500 | [diff] [blame] | 13 | - make lint |
| Joey Armstrong | 018aa3d | 2024-01-02 21:40:15 -0500 | [diff] [blame] | 14 | - make protos |
| 15 | - make build |
| Joey Armstrong | 56334fc | 2023-01-15 22:53:19 -0500 | [diff] [blame] | 16 | - make test |
| 17 | |
| 18 | Versioning |
| 19 | ---------- |
| 20 | |
| 21 | - Based on VERSION file contents in root directory of the repository. |
| 22 | |
| Joey Armstrong | 018aa3d | 2024-01-02 21:40:15 -0500 | [diff] [blame] | 23 | Release Preparation |
| 24 | ------------------- |
| 25 | |
| 26 | - Create a jira ticket for tracking the repo:voltha-protos upgrade. |
| 27 | - Update copyright notice in source to span the current year. |
| 28 | - Regenerate voltha.pb file: |
| 29 | |
| 30 | - make clean |
| 31 | - make voltha.pb |
| 32 | - voltha.pb is checked in, should it be ?!? |
| 33 | - File is .PHONY, always rebuilt, is a static copy needed for usage or bootstrapping ? |
| Joey Armstrong | 56334fc | 2023-01-15 22:53:19 -0500 | [diff] [blame] | 34 | |
| 35 | - Bump VERSION file to a non-dev semantic version. |
| 36 | - See Validate above |
| 37 | - Commit and approve to trigger a build |
| Joey Armstrong | 018aa3d | 2024-01-02 21:40:15 -0500 | [diff] [blame] | 38 | |
| 39 | Release Branching and Tagging |
| 40 | ----------------------------- |
| 41 | |
| 42 | - Create and tag release branch (voltha-2.12) |
| 43 | - Update .gitreview file contents to checkin on the release branch: |
| 44 | |
| 45 | - defaultbranch=voltha-2.12 |
| 46 | |
| 47 | - Commit and merge after jenkins job passes. |
| 48 | |
| 49 | Post Release Action |
| 50 | =================== |
| 51 | |
| 52 | - Clone master branch from repository. |
| 53 | - Bump VERSION file to next minor version with a ``*-dev`` suffix. |
| 54 | |
| 55 | - ie {major}.{minor+1}.0.``-dev`` |
| 56 | |
| 57 | - Future checkins on master must not conflict with release branch versioning. |
| 58 | |
| 59 | Jira Tickets |
| 60 | ============ |
| 61 | |
| 62 | - Create a jira ticket for tracking the repo:voltha-protos upgrade. |
| 63 | - Create sub-tasks attached to the jira ticket to track jenkins job failures. |
| 64 | - Close the ticket after |
| 65 | |
| 66 | - Release branch created |
| 67 | - VERSION file edit on master has bumped version to {major}.{minor+1}.0.``-dev`` |
| 68 | - All jenkins jobs for repo:voltha-protos reports PASS. |
| Joey Armstrong | a144ef3 | 2024-01-11 11:26:41 -0500 | [diff] [blame] | 69 | |
| 70 | See Also |
| 71 | ======== |
| 72 | - :ref:`howto_code_voltha-protos` |