Skip to content

Commit 33edb40

Browse files
committed
Update backport instructions to apply to any release
- Remove interaction with DP0.2 - Use more obvious alias for release number
1 parent 8c0a89c commit 33edb40

File tree

1 file changed

+26
-34
lines changed

1 file changed

+26
-34
lines changed

work/backports.rst

Lines changed: 26 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2,81 +2,73 @@
22
Backporting Tickets to a Release Branch
33
#######################################
44

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.
78

8-
1) First, add the label "backport-v23" to your jira ticket.
9+
1) First, add the label "backport-v88" to your jira ticket.
910

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.
1112
Continue merging your ticket to the default branch (``main``) and mark the ticket ``Done`` per instructions in the normal :doc:`flow`.
1213

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."
1415

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.
1617

1718
.. code-block:: bash
1819
19-
git checkout v23.0.x
20+
git checkout v88.0.x
2021
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):
2223

2324
.. code-block:: bash
2425
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
2829
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``).
3031

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``.
3233

3334
.. code-block:: bash
3435
3536
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>
3839
3940
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.
4142

4243
.. code-block:: bash
4344
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
4647
git cherry-pick <ticket commit>
4748
4849
The following may help you find your hash[es] from ``main``:
4950
``git show --quiet $(git log --oneline | grep 'Merge.*DM-XXXXX' | cut -d' ' -f1)^2``
5051

5152
5) Resolve any rebase or cherry-pick problems depending on your method.
5253
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.
5455
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``.
5657
If you are unsure of the recommended env for the release, check with the release manager.
5758

5859
.. code-block:: bash
5960
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
6162
PRODUCTS: lsst_distrib lsst_ci ci_imsim ci_hsc
62-
SPLENV_REF: 0.8.0
63+
SPLENV_REF: <default_or_recommended_for_release>
6364
6465
You may find that the ticket cannot be cleanly backported without first backporting another ticket.
6566

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`,
6768
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``.
6970
If the backport was clean, you may self-review.
7071
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,
7172
but please *do not* put your ticket status back into ``In Review`` on Jira.
7273

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

Comments
 (0)