blob: 3c9334fab413237e9633d82c6117dca08418dbca [file] [log] [blame]
Joey Armstrong864db882023-08-24 15:01:35 -04001Pull request followup
2=====================
3
4Once a patch has been submitted gerrit can be used to track progress.
5
6Find your patch
7---------------
8
9| Begin by viewing the history for your patch in gerrit.
10| A patch can be accessed in a few different ways.
11
12Item of Note:
13
14- A Gerrit Change-Id is required to interact with a patch. This hashed
15 value will be distinct from the underlying git checksum used when
16 changes are stored in a repository.
17
18Capture commit message output
19^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
20
21Gerrit commit hash and a URL are readily available in output.
22
23.. code-block:: shell-session
24 :linenos:
25 :emphasize-lines: 22
26
27 % git commit -F ../jira/5100
28 % git rebase
29 % git review --reviewers tux@onf.org
30
31 remote:
32 remote: Processing changes: (\)
33 remote: Processing changes: (|)
34 remote: Processing changes: (/)
35 remote: Processing changes: (-)
36 remote: Processing changes: (\)
37 remote: Processing changes: (|)
38 remote: Processing changes: (/)
39 remote: Processing changes: (-)
40 remote: Processing changes: new: 1 (\)
41 remote: Processing changes: refs: 1, new: 1 (\)
42 remote: Processing changes: refs: 1, new: 1 (\)
43 remote: Processing changes: refs: 1, new: 1, done
44 remote:
45 remote: SUCCESS
46 remote:
47 remote: https://gerrit.opencord.org/c/ci-management/+/34600 Disable jobs dependent on offline menlo-3 node [NEW]
48 fremote:
49 To ssh://gerrit.opencord.org:29418/ci-management.git
50 * [new reference] HEAD -> refs/for/master%topic=dev-joey
51
52.. list-table:: Git commit message
53 :widths: 20, 5, 60
54 :header-rows: 1
55
56 * - Id
57 - Line
58 - Description
59 * -
60 - 2
61 - Git commit hash
62 * - `34598 <https://gerrit.opencord.org/c/ci-management/+/34598>`_
63 - 10
64 - Gerrit URL for direct patch access
65 * -
66 - 14
67 -
68
69Git log
70^^^^^^^
71
72Gerrit Change-IDs are appended as the last line in a commit mesage.
73git log can be used to search for them.
74
75.. code-block:: shell-session
76 :linenos:
77 :emphasize-lines: 3,14
78
79 % git log --author="joey" | less
80
81 commit 23ce887c4cb3f98506536e00c58ffc8c2af16afe
82 Author: Joey Armstrong <joey@opennetworking.org>
83 Date: Thu Aug 24 09:46:22 2023 -0400
84
85 [VOL-5009] - Update release notes
86
87 release_notes/voltha_2.12.rst
88 -----------------------------
89 o Import Mahir(s) word doc containing tickets and descriptions.
90 o Reformat using a grid layout so tickets and description are aligned.
91
92 Change-Id: Ic8ca17f5923496731f88ce8918c9852d904ea066
93
94.. list-table:: Git log commit IDs
95 :widths: 20, 5, 60
96 :header-rows: 1
97
98 * - Id
99 - Line
100 - Description
101 * - 23ce887c4cb3f98506536e00c58ffc8c2af16afe
102 - 3
103 - Git commit hash
104 * - Ic8ca17f5923496731f88ce8918c9852d904ea066
105 - 14
106 - Gerrit Change-Id
107
108
109Patch lookup by Change-Id string
110^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
111
112When you have a Change-Id value (~43 chars)
113
114- Change-Id: Ic8ca17f5923496731f88ce8918c9852d904ea066
115
116 - Visit the `Gerrit dashboard <https://gerrit.opencord.org/dashboard/self>`_
117 - Paste Change-Id into the search box at the top right
118 - Gerrit UI will navigate to the patch.
119
120Brute force patch lookup
121^^^^^^^^^^^^^^^^^^^^^^^^
122
123- Visit `Gerrit dashboard open+is:wip <https://gerrit.opencord.org/q/status:open+-is:wip>`_
124
125 - View all open/unmerged patches
126 - Scroll down through the list until something of interest is found.
127 - Under the # column (2nd column on left hand side) right click and open to view the patch.
128 - For example: `repo:voltha-system-tests <https://gerrit.opencord.org/c/voltha-system-tests/+/33380>`_
129
130Patch history and jenkins jobs
131------------------------------
132
133While viewing a patch (`repo:voltha-system-tests <https://gerrit.opencord.org/c/voltha-system-tests/+/33380>`_)
134scroll down to the 'Change Log' section at the bottom.
135| Line items represent historical comments, code review messages and
136processed job status.
137
138Entries prefixed with ``Jenkins Technical User`` contain jenkins job
139information. Jenkins pipeline jobs are constructed by performing
140several atomic tasks each of which will generate a log with status.
141
142To view job logs click on an entry to expand (Verified +1, 4th entry from
143the bottom) to view a set of clickable jenkins URLs.
144
145- `Patch 33380 <https://gerrit.opencord.org/c/voltha-system-tests/+/33380>`_
146 - `verify_voltha-system-tests_unit-test <https://jenkins.opencord.org/job/verify_voltha-system-tests_unit-test>`_ : SUCCESS
147 - `verify_voltha-system-tests_licensed <https://jenkins.opencord.org/job/verify_voltha-system-tests_licensed>`_ : SUCCESS
148 - `verify_voltha-system-tests_sanity-test <https://jenkins.opencord.org/job/verify_voltha-system-tests_sanity-test>`_ : FAILED