From 898d3487999ad3cb59d1e899506ea775161687b0 Mon Sep 17 00:00:00 2001
From: Patrik Polakovič <patrik@alphamail.org>
Date: Nov 25 2024 13:31:21 +0000
Subject: Update release candidate SOPs


Signed-off-by: Patrik Polakovič <patrik@alphamail.org>

---

diff --git a/modules/release_guide/pages/beta_RC_compose.adoc b/modules/release_guide/pages/beta_RC_compose.adoc
index 51310a9..d4616ec 100644
--- a/modules/release_guide/pages/beta_RC_compose.adoc
+++ b/modules/release_guide/pages/beta_RC_compose.adoc
@@ -10,12 +10,12 @@ candidate composes are not currently automated.
 |===
 |Compose Name |Configuration File |Compose Script
 |Beta |fedora-beta.conf |release-candidate.sh
-|GA |fedora-final.conf |release-candidate.sh
 |===
 
 == Action
 
 === Create the fedora-beta.conf configuration file using the script
+
 The script can be found https://pagure.io/pungi-fedora/blob/main/f/create-candidate-configs.py[here].
 
 There is a mandatory argument to specify the milestone to generate (beta or final)
@@ -72,7 +72,7 @@ $ koji tag-build f{branched}-compose [build1 build2 ...]
 [NOTE]
 ====
 These steps may be completed on a local machine as long as the user has
-appropriate permissions in the koji tool.
+appropriate permissions in the Koji tool.
 ====
 
 === Running the Compose
@@ -118,10 +118,13 @@ $ git fetch origin
 $ git checkout f{branched}
 $ git pull origin f{branched}
 ....
-. Run the compose
+. Run the compose and redirect the output to a file (in case it's needed later)
 +
+[source,subs="attributes+"]
 ....
-$ sudo ./release-candidate.sh 41 Beta-#.#
+$ sudo ./release-candidate.sh {branched} Beta-#.# >& {branched}_Beta-#.#.out
+# Example:
+# $ sudo ./release-candidate.sh {branched} Beta-1.3 >& {branched}_Beta-1.3.out
 ....
 +
 The first argument is the release number. The second argument is the
diff --git a/modules/release_guide/pages/final_RC_compose.adoc b/modules/release_guide/pages/final_RC_compose.adoc
index 58f030e..c1d131f 100644
--- a/modules/release_guide/pages/final_RC_compose.adoc
+++ b/modules/release_guide/pages/final_RC_compose.adoc
@@ -36,11 +36,14 @@ $ koji list-tagged f{branched}-compose
 +
 The tagged builds from the previous composes should all be present in
 the output from the previous step. Consult the request ticket for the
-list of builds expected in this output.
+list of builds expected in this output. The request ticket may list
+commands to un-tag existing tagged builds and tag the new requested
+builds; if so, you can review these commands and run them. Otherwise,
+the steps to do this manually are documented below.
 +
 [NOTE]
 ====
-The very first run of a GA compose should have no builds
+The very first run of a Beta or GA compose should have no builds
 listed under the compose tag. It is important to clear preexisting
 builds from the compose tag when moving between the Beta and RC
 composes. Verify that these builds were removed.
@@ -69,7 +72,7 @@ $ koji tag-build f{branched}-compose [build1 build2 ...]
 [NOTE]
 ====
 These steps may be completed on a local machine as long as the user has
-appropriate permissions in the koji tool.
+appropriate permissions in the Koji tool.
 ====
 
 === Running the Compose
@@ -115,20 +118,27 @@ $ git fetch origin
 $ git checkout f{branched}
 $ git pull origin f{branched}
 ....
-. Run the compose
+. Run the compose and redirect the output to a file (in case it's needed later)
 +
+[source,subs="attributes+"]
 ....
-$ sudo ./release-candidate.sh 41_RC-#.#
+$ sudo ./release-candidate.sh {branched} RC-#.# >& {branched}_RC-#.#.out
+# Example:
+# $ sudo ./release-candidate.sh {branched} RC-1.3 >& {branched}_RC-1.3.out
 ....
 +
-The numbering scheme begins with 1.1 and the second number is
-incremented after each compose.
+The first argument is the release number. The second argument is the
+compose label. The numbering scheme begins with 1.1 and the second
+number is incremented after each compose. The first number always
+remains at 1 for Fedora composes.
 +
 [NOTE]
 ====
-Pungi requires numbers in the format `major.minor` as an argument (e.g. `1.4`).
-It is because of this that composes always start with the number 1 and the second
-number is incremented with each compose.
+productmd requires the label version to be in this format (because
+both numbers may be incremented for other products that use productmd
+metadata, and have different meanings). It is because of this that
+composes always start with the number 1 and the second number is
+incremented with each compose.
 ====
 +
 [NOTE]