| Joey Armstrong | 34f1840 | 2023-07-21 18:58:10 -0400 | [diff] [blame^] | 1 | .. _pull-request--commit-message: |
| 2 | |
| 3 | Repository commit message |
| 4 | ========================= |
| 5 | |
| 6 | - First line in a commit message is special. |
| 7 | - 50 cpl max to avoid complaints about length. |
| 8 | - Mention a jira ticket (VOL-xxxx) and the ticket will receive status updates from jenkins. |
| 9 | |
| 10 | .. code:: bash |
| 11 | |
| 12 | [VOL-5048] - Build and deploy for VOLTHA v2.12 release. |
| 13 | |
| 14 | api/pom.xml |
| 15 | app/pom.xml |
| 16 | pom.xml |
| 17 | ----------- |
| 18 | o Update copyright notice to span CCYY. |
| 19 | o Update maven plugins spotbugs and findsecbugs. |
| 20 | o Update sadis component to vX.Y.Z |
| 21 | |
| 22 | pkg/* |
| 23 | Makefile |
| 24 | ---------- |
| 25 | o Update copyright notice. |
| 26 | o Run gofmt -s -w on all golang sources. |
| 27 | |
| 28 | VERSION |
| 29 | ------- |
| 30 | o Increment version string to non-dev for release. |
| 31 | |
| 32 | Job Directives |
| 33 | -------------- |
| 34 | verify_{project}_licensed |
| 35 | verify_{project}_tag-collision |
| 36 | verify_{project}_unit-test |
| 37 | verify_{project}_sanity-test |
| 38 | |
| 39 | hardware test functional tests |
| 40 | voltha test openonu multiolt |
| 41 | voltha 2.8 test openonu multiolt |
| 42 | |
| 43 | git commit ... |
| 44 | -------------- |
| 45 | |
| 46 | - A commit message can be constructed using either |
| 47 | |
| 48 | - -F <file> |
| 49 | - --message="inlined text" |
| 50 | |
| 51 | .. code:: bash |
| 52 | |
| 53 | $ vi commit.txt |
| 54 | $ git add *stuff* |
| 55 | $ git commit --F ./commit.txt |
| 56 | # appropriate git rebase command |
| 57 | $ git review --reviewers tux@onf.org foo@onf.org bar@onf.org |
| 58 | |
| 59 | Commit Message: extra credit |
| 60 | ++++++++++++++++++++++++++++ |
| 61 | |
| 62 | Additional commit message directives are available that will augment tasks |
| 63 | performed by a job. Additional test suites can be requested for a job run |
| 64 | by including tokens found here. |
| 65 | |
| 66 | `Tokens |
| 67 | <https://docs.voltha.org/master/testing/voltha_test_automation.html#per-patchset-verification-jobs>`_ can be embedded within a commit message to enable running additional test suites as part of jenkins validation. |
| 68 | |
| 69 | Troubleshooting: |
| 70 | ++++++++++++++++ |
| 71 | |
| 72 | There have been a few reports of additional testing not beeing initiated |
| 73 | by a commit. If you encounter this behavior visit the |
| 74 | `VOLTHA jira site <https://jira.opencord.org/secure/Dashboard.jspa>`_ |
| 75 | and open a trouble ticket detailing the changeset URL or a repository |
| 76 | and commit message text. |
| 77 | |
| 78 | Commit hooks can be repository specific and may need to be |
| 79 | deployed/enabled/updated to support requestd functionality. |