From: Yuri Weinstein <yweinste@redhat.com>
Date: Wed, 19 Apr 2023 21:14:45 +0000 (-0700)
Subject: docs: added note for the TAG option and a note for 'cherry-pick'
X-Git-Tag: v19.0.0~1276^2~1
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=b2f2418dbc581bb753047778a990da008cc8a808;p=ceph.git

docs: added note for the TAG option and a note for 'cherry-pick'

Signed-off-by: Yuri Weinstein <yweinste@redhat.com>
---

diff --git a/doc/dev/release-process.rst b/doc/dev/release-process.rst
index 3750759b846b..bedc08e5721e 100644
--- a/doc/dev/release-process.rst
+++ b/doc/dev/release-process.rst
@@ -41,8 +41,8 @@ Hotfix Release Process Deviation
 
 A hotfix release has a couple differences.
 
-1. Check out the most recent tag. For example, if we're releasing a hotfix on top of 17.2.3, ``git checkout -f -B quincy-release origin/v17.2.3``
-2. ``git cherry-pick -x`` the necessary hotfix commits
+1. Check out the most recent tag. For example, if we're releasing a hotfix on top of 17.2.3, ``git checkout -f -B quincy-release tags/v17.2.3``
+2. ``git cherry-pick -x`` the necessary hotfix commits (Note: only "cherry-pick" must be used)
 3. ``git push -f origin quincy-release``
 4. Notify the "Build Lead" to start the build.
 5. The "Build Lead" should set ``RELEASE_TYPE=HOTFIX`` instead of ``STABLE``.
@@ -95,6 +95,8 @@ We'll use a stable/regular 15.2.17 release of Octopus as an example throughout t
     RELEASE_TYPE=STABLE
     ARCHS=x86_64 arm64
 
+NOTE: if for some reason the build has to be restarted (for example if one distro failed) then the ``TAG`` option has to be unchecked.
+
 4. Use https://docs.ceph.com/en/latest/start/os-recommendations/?highlight=debian#platforms to determine the ``DISTROS`` parameter.  For example,
 
     +-------------------+-------------------------------------------+
@@ -118,7 +120,7 @@ Packages take hours to build. Use those hours to create the Release Notes and An
 2. ceph.io Release Notes (e.g., `v15.2.17's ceph.io.git (www.ceph.io) PR <https://github.com/ceph/ceph.io/pull/427>`_)
 3. E-mail announcement
 
-See `the Ceph Tracker wiki page that explains how to write the release notes <https://tracker.ceph.com/projects/ceph-releases/wiki/HOWTO_write_the_release_notes>`_. 
+See `the Ceph Tracker wiki page that explains how to write the release notes <https://tracker.ceph.com/projects/ceph-releases/wiki/HOWTO_write_the_release_notes>`_.
 
 4. Signing and Publishing the Build
 ===================================
@@ -131,9 +133,9 @@ See `the Ceph Tracker wiki page that explains how to write the release notes <ht
 
       ssh ubuntu@signer.front.sepia.ceph.com
       sync-pull ceph [pacific|quincy|etc] <sha1>
- 
+
    Example::
-    
+
       $ sync-pull ceph octopus 8a82819d84cf884bd39c17e3236e0632ac146dc4
       sync for: ceph octopus
       ********************************************
@@ -149,7 +151,7 @@ See `the Ceph Tracker wiki page that explains how to write the release notes <ht
       db/contents.cache.db
               507.90K 100%    1.95MB/s    0:00:00 (xfr#2, to-chk=462/467)
       db/packages.db
-      
+
       etc...
 
 #. Sign the DEBs:
@@ -172,7 +174,7 @@ See `the Ceph Tracker wiki page that explains how to write the release notes <ht
       --> signing: /opt/repos/ceph/octopus-15.2.17/debian/jessie/dists/focal/Release
       --> Running command: gpg --batch --yes --armor --detach-sig --output Release.gpg Release
       --> Running command: gpg --batch --yes --clearsign --output InRelease Release
-      
+
       etc...
 
 #. Sign the RPMs:
@@ -182,7 +184,7 @@ See `the Ceph Tracker wiki page that explains how to write the release notes <ht
       sign-rpms octopus
 
    Example::
-   
+
       $ sign-rpms octopus
       Checking packages in: /opt/repos/ceph/octopus-15.2.17/centos/7
       signing:  /opt/repos/ceph/octopus-15.2.17/centos/7/SRPMS/ceph-release-1-1.el7.src.rpm
@@ -190,7 +192,7 @@ See `the Ceph Tracker wiki page that explains how to write the release notes <ht
       signing:  /opt/repos/ceph/octopus-15.2.17/centos/7/SRPMS/ceph-15.2.17-0.el7.src.rpm
       /opt/repos/ceph/octopus-15.2.17/centos/7/SRPMS/ceph-15.2.17-0.el7.src.rpm:
       signing:  /opt/repos/ceph/octopus-15.2.17/centos/7/noarch/ceph-mgr-modules-core-15.2.17-0.el7.noarch.rpm
-   
+
       etc...
 
 5. Publish the packages to download.ceph.com:
@@ -215,7 +217,7 @@ Version Commit PR
 
 The `ceph-tag Jenkins job <https://jenkins.ceph.com/job/ceph-tag>`_ creates a Pull Request in ceph.git that targets the release branch.
 
-If this was a regular release (not a hotfix release or a security release), the only commit in that Pull Request should be the version commit.  For example, see `v15.2.17's version commit PR <https://github.com/ceph/ceph/pull/47520>`_. 
+If this was a regular release (not a hotfix release or a security release), the only commit in that Pull Request should be the version commit.  For example, see `v15.2.17's version commit PR <https://github.com/ceph/ceph/pull/47520>`_.
 
 Request a review and then merge the Pull Request.