|
2 | 2 | Backporting Tickets to a Release Branch |
3 | 3 | ####################################### |
4 | 4 |
|
5 | | -So you have a ticket that you think should be backported to ``v23.0.0`` and/or be used for DP0.2. |
6 | | -What next? |
| 5 | +So you have a ticket that you think should be backported to the release branch? What next? |
| 6 | +Note, these instructions use v88 as an alias for the release of the science pipelines to backport to. |
| 7 | +Replace the 88 with 24, 27, or whatever major release number we are on now. |
7 | 8 |
|
8 | | -1) First, add the label "backport-v23" to your jira ticket. |
| 9 | +1) First, add the label "backport-v88" to your jira ticket. |
9 | 10 |
|
10 | | - This will flag it for review by the DM-CCB or the DP0.2 campaign managers. |
| 11 | + This will flag it for review by the DM-CCB. |
11 | 12 | Continue merging your ticket to the default branch (``main``) and mark the ticket ``Done`` per instructions in the normal :doc:`flow`. |
12 | 13 |
|
13 | | -2) Wait for approval. The ticket will gain the label "backport-approved." A comment will be posted on the ticket that you may start the backporting process. |
| 14 | +2) Wait for approval. The ticket will gain the label "backport-approved." |
14 | 15 |
|
15 | | -3) Checkout the release branch, ``v23.0.x``, for each repo affected by your ticket. |
| 16 | +3) Checkout the release branch, ``v88.0.x``, for each repo affected by your ticket. |
16 | 17 |
|
17 | 18 | .. code-block:: bash |
18 | 19 |
|
19 | | - git checkout v23.0.x |
| 20 | + git checkout v88.0.x |
20 | 21 |
|
21 | | - If the repo does not already have a ``v23.0.x`` branch, you need to create one based on ``v23.0.0.rc1`` (not the latest rcN, although that should be identical): |
| 22 | + If the repo does not already have a ``v88.0.x`` branch, you need to create one based on ``v88.0.0.rc1`` (not the latest rcN, although that should be identical): |
22 | 23 |
|
23 | 24 | .. code-block:: bash |
24 | 25 |
|
25 | | - git checkout v23.0.0.rc1 |
26 | | - git checkout -b v23.0.x |
27 | | - git push -u origin v23.0.x |
| 26 | + git checkout v88.0.0.rc1 |
| 27 | + git checkout -b v88.0.x |
| 28 | + git push -u origin v88.0.x |
28 | 29 |
|
29 | | - Now treat ``v23.0.x`` same as you would the default branch (``main``). |
| 30 | + Now treat ``v88.0.x`` same as you would the default branch (``main``). |
30 | 31 |
|
31 | | -4) Create a copy of your ticket branch called ``tickets/DM-XXXXX-v23``. |
| 32 | +4) Create a copy of your ticket branch called ``tickets/DM-XXXXX-v88``. |
32 | 33 |
|
33 | 34 | .. code-block:: bash |
34 | 35 |
|
35 | 36 | git checkout tickets/DM-XXXXX |
36 | | - git checkout -b tickets/DM-XXXXX-v23 |
37 | | - git rebase --onto v23.0.x <sha_of_last_commit_before_your_branch> |
| 37 | + git checkout -b tickets/DM-XXXXX-v88 |
| 38 | + git rebase --onto v88.0.x <sha_of_last_commit_before_your_branch> |
38 | 39 |
|
39 | 40 | In a new clone, this branch may not exist anymore if you have already merged your PR because merged branches may be automatically deleted. |
40 | | - In this case, you can branch ``tickets/DM-XXXXX-v23`` from ``v23.0.x``, and cherry-pick the ticket commits. |
| 41 | + In this case, you can branch ``tickets/DM-XXXXX-v88`` from ``v88.0.x``, and cherry-pick the ticket commits. |
41 | 42 |
|
42 | 43 | .. code-block:: bash |
43 | 44 |
|
44 | | - git checkout v23.0.x |
45 | | - git checkout -b tickets/DM-XXXXX-v23 |
| 45 | + git checkout v88.0.x |
| 46 | + git checkout -b tickets/DM-XXXXX-v88 |
46 | 47 | git cherry-pick <ticket commit> |
47 | 48 |
|
48 | 49 | The following may help you find your hash[es] from ``main``: |
49 | 50 | ``git show --quiet $(git log --oneline | grep 'Merge.*DM-XXXXX' | cut -d' ' -f1)^2`` |
50 | 51 |
|
51 | 52 | 5) Resolve any rebase or cherry-pick problems depending on your method. |
52 | 53 | Continue using the same procedure outlined in :ref:`review-preparation`. |
53 | | - Check that it cleanly builds via scons. There should be a latest shared v23.0.0.rcN stack on lsst-devl. |
| 54 | + Check that it cleanly builds via scons. There should be a latest shared v88.0.0.rcN stack on lsst-devl. |
54 | 55 | Run Jenkins. When running Jenkins, build against the release branch and rc1 even if later rcNs exist. |
55 | | - The default ``SPLENV_REF`` may no longer be appropriate for ``v23.0.x``. |
| 56 | + The default ``SPLENV_REF`` may no longer be appropriate for ``v88.0.x``. |
56 | 57 | If you are unsure of the recommended env for the release, check with the release manager. |
57 | 58 |
|
58 | 59 | .. code-block:: bash |
59 | 60 |
|
60 | | - REFS: tickets/DM-XXXXX-v23 v23.0.x v23.0.0.rc1 |
| 61 | + REFS: tickets/DM-XXXXX-v88 v88.0.x v88.0.0.rc1 |
61 | 62 | PRODUCTS: lsst_distrib lsst_ci ci_imsim ci_hsc |
62 | | - SPLENV_REF: 0.8.0 |
| 63 | + SPLENV_REF: <default_or_recommended_for_release> |
63 | 64 |
|
64 | 65 | You may find that the ticket cannot be cleanly backported without first backporting another ticket. |
65 | 66 |
|
66 | | -6) When it passes, merge to ``v23.0.x`` using the same procedure outlined in :ref:`workflow-code-review-merge`, |
| 67 | +6) When it passes, merge to ``v88.0.x`` using the same procedure outlined in :ref:`workflow-code-review-merge`, |
67 | 68 | including creating a pull request. |
68 | | - On your pull request, remember to change the base branch to ``v23.0.x``. |
| 69 | + On your pull request, remember to change the base branch to ``v88.0.x``. |
69 | 70 | If the backport was clean, you may self-review. |
70 | 71 | If the backport was not clean and you would like another pair of eyes, you may ask someone to hit the "Approved" button on GitHub, |
71 | 72 | but please *do not* put your ticket status back into ``In Review`` on Jira. |
72 | 73 |
|
73 | | -7) When merged to ``v23.0.x``, label your Jira ticket ``backport-done``. |
74 | | - |
75 | | - |
76 | | -Interaction between v23 and DP0.2 |
77 | | ---------------------------------- |
78 | | -Before the full-scale data release processing of step1 commences for DP0.2, a new rcN release will be built on approximately weekly cadence. |
79 | | -This weekly cadence follows the weekly review of backport requests. |
80 | | - |
81 | | -After step1 begins and 23.0.0 is released, the current plan is to increment the release versions. |
82 | | -This backporting process will remain the same, but with evolving release tags and release branch numbers. |
| 74 | +7) When merged to ``v88.0.x``, label your Jira ticket ``backport-done``. |
0 commit comments