| Joey Armstrong | b0b790b | 2022-12-14 20:35:54 -0500 | [diff] [blame] | 1 | VOLTHA Release: voltctl |
| 2 | ======================= |
| 3 | |
| 4 | Release Builds howto: |
| 5 | --------------------- |
| 6 | - Increment the VERSION file to a major or minor point release. |
| 7 | - Initiate a jenkins job to build components (WIP: searching). |
| Joey Armstrong | b0b790b | 2022-12-14 20:35:54 -0500 | [diff] [blame] | 8 | |
| Joey Armstrong | 8d62cd9 | 2022-12-22 13:53:48 -0500 | [diff] [blame] | 9 | - `repo::voltctl <https://gerrit.opencord.org/plugins/gitiles/voltctl/+/refs/heads/master>`__, Gerrit example: `33551 <https://gerrit.opencord.org/c/voltctl/+/33551>`_. |
| 10 | - At least two jenkins jobs need to run: |
| 11 | |
| 12 | - version-tag_wildcard |
| 13 | - github-release_voltctl |
| 14 | |
| 15 | - Verify `git tags <https://github.com/opencord/voltctl/tags>`_ |
| 16 | |
| 17 | - A SemVer tag was created (vee prefix v{semver} signifies a golang package). |
| 18 | - Verify the `package(v1.8.0) <https://github.com/opencord/voltctl/releases/tag/v1.8.0>`_ contains more than just source archives (gz, zip): |
| 19 | - The `tags page <https://github.com/opencord/voltctl/tags>`_ index lacks ``Notes`` and ``Downloads`` links. |
| 20 | |
| 21 | - A valid `package(v1.7.6) <https://github.com/opencord/voltctl/releases/tag/v1.7.6>`_ will include: |
| 22 | |
| 23 | - The `tags page <https://github.com/opencord/voltctl/tags>`_ index contains ``Notes`` and ``Downloads`` links. |
| 24 | - A checksum file |
| 25 | - Versioned voltctl binaries for several platforms. |
| 26 | - Source code bundles (tar.gz and zip). |
| 27 | |
| 28 | - `Released version <https://api.github.com/repos/opencord/voltctl/releases/latest>`_ will be consumed by jenkins installer vars/installVoltctl.groovy. |
| 29 | |
| Joey Armstrong | b0b790b | 2022-12-14 20:35:54 -0500 | [diff] [blame] | 30 | |
| 31 | Create an official voltctl release |
| 32 | ---------------------------------- |
| 33 | - `installVoltctl.groovy <https://gerrit.opencord.org/plugins/gitiles/ci-management/+/refs/heads/master/vars/installVoltctl.groovy#53>`_ |
| Joey Armstrong | 8d62cd9 | 2022-12-22 13:53:48 -0500 | [diff] [blame] | 34 | depends on `github/releases/latest <https://api.github.com/repos/opencord/voltctl/releases/latest>`_ for versioned release information. |
| Joey Armstrong | b0b790b | 2022-12-14 20:35:54 -0500 | [diff] [blame] | 35 | |
| Joey Armstrong | 8d62cd9 | 2022-12-22 13:53:48 -0500 | [diff] [blame] | 36 | - To generate a release commit changes to `repo::voltctl <https://gerrit.opencord.org/plugins/gitiles/voltctl>`__: |
| Joey Armstrong | b0b790b | 2022-12-14 20:35:54 -0500 | [diff] [blame] | 37 | |
| Joey Armstrong | 8d62cd9 | 2022-12-22 13:53:48 -0500 | [diff] [blame] | 38 | - Modify VERSION file major/minor numbers for the upcoming release. |
| 39 | - Remove any -dev or patch modifiers. |
| 40 | - Create a pull request for review. |
| 41 | - Changes will be published when the jenkins job github-release-voltctl is run. |
| Joey Armstrong | b0b790b | 2022-12-14 20:35:54 -0500 | [diff] [blame] | 42 | |
| 43 | - Verify the release version contains a checksum file: |
| 44 | |
| 45 | - checksum.SHA256 |
| 46 | - voltctl-1.7.6-darwin-amd64 |
| 47 | - voltctl-1.7.6-linux-amd64 |
| 48 | - voltctl-1.7.6-linux-arm64 |
| 49 | - voltctl-1.7.6-windows-amd64 |
| 50 | - Source code (zip) |
| 51 | - Source code (tar.gz) |
| 52 | |
| 53 | :ref:`voltctl-see-also` |