<h1>SDP Release Process Overview</h1>
<h2>Introduction</h2>
<p>This document describes the process used to release the Server Deployment Package (SDP). This is intended for those developing the SDP.</p>
<p>This is the first release process document written for the SDP's Streams-based depot structure (<code>//p4-sdp/...</code>), following the Classic-to-Streams migration. The stream topology and terminology used throughout are:</p>
<ul>
<li><code>//p4-sdp/main</code> -- a <code>mainline</code> stream, long-lived and stable, reflecting whatever was most recently released.</li>
<li><code>//p4-sdp/dev</code> -- a <code>development</code> stream, parented by <code>main</code>. Long-lived, with work in progress at any given time, but always kept stable enough that a release could be cut from it on short notice.</li>
<li><code>//p4-sdp/dev_*</code> streams -- short-lived, per-task <code>development</code> streams parented by <code>dev</code> (e.g. <code>dev_rebrand</code>, or a future <code>dev_SDP-<issue></code>), used for larger or higher-risk work. Small, low-risk, or hyper-urgent changes may instead go straight to <code>dev</code>.</li>
<li><code>//p4-sdp/r<YYYY>.<N>[.<P>]</code> release streams (e.g. <code>r26.1.0</code>) -- <code>release</code>-type streams parented by <code>main</code>, cut fresh for each GA release or patch. Long-lived and stable except briefly during the release process itself. <strong>Patches do not modify an existing release stream</strong> -- a patch is a brand new release stream cut from <code>main</code> (e.g. <code>r26.1.1</code>), keeping the flow uniformly <code>dev -> main -> release</code> for every release, GA or patch.</li>
</ul>
<p><code>install_sdp.sh</code> downloads the SDP tarball from a single fixed URL under <code>main</code> (see Steps 19-20), never from a specific release stream's own URL -- so, unlike the release stream name itself, that URL never needs editing per release, and mirrors the one fixed download location the Classic depot always had. This depends on <code>downloads/</code> being <code>isolate</code>d on <code>main</code>, so a pre-release build never leaks into <code>main</code> via ordinary Copy Up, and <code>main</code>'s tarball only ever changes via the deliberate publish step.</p>
<h2>Preparation</h2>
<p>Use a dedicated set of release workspace clients, separate from any you use for day-to-day SDP development, and free of cruft files (editor temp files, <code>.DS_Store</code>, etc.) -- the packaging mechanism excludes known-cruft file patterns, but a clean workspace avoids relying on that as a safety net.</p>
<p>Because different steps of this process operate on different streams, and a Perforce client can only be switched to one stream at a time, use <strong>one client per stream</strong>, each rooted in its own directory. A convenient convention, matching the directory names used throughout this document, is to root them as sibling directories, e.g.:</p>
<p><code>
~/re/p4-sdp/dev (client switched to //p4-sdp/dev)
~/re/p4-sdp/main (client switched to //p4-sdp/main)
</code></p>
<p>A third client, for whichever release stream is currently being cut (e.g. <code>~/re/p4-sdp/r26.1.0</code>), is created fresh as part of the process (see the "Cut the Release Stream" step below) and can be discarded once the release ships.</p>
<p>Note: <code>tools/</code> now lives inside each stream (it does not sit outside <code>dev</code>/<code>main</code> the way it did in the Classic depot layout), so each of these clients has its own copy of the release tooling in its own <code>tools/</code> subdirectory.</p>
<p><strong>macOS note</strong>: several scripts used throughout this process (<code>package_downloads.sh</code>, <code>gen_file_format_check.sh</code>, and possibly others) require bash 4.x+ features. macOS's own <code>/bin/bash</code> is permanently stuck at 3.2 for licensing reasons Apple controls, not us -- if you're running this process from a Mac (as more than one of us does), install a modern bash (e.g. via <code>homebrew</code>) and invoke these scripts explicitly with it (<code>/opt/homebrew/bin/bash somescript.sh</code>) rather than relying on <code>./somescript.sh</code> or a bare <code>bash somescript.sh</code>, either of which may pick up the ancient system one depending on your <code>PATH</code>.</p>
<p>Throughout this document, <code>$WSRoot</code> refers to the root directory of whichever client a given step says to use. From inside that client (anywhere under its root), you can always determine it with:</p>
<p><code>
WSRoot=$(p4 -ztag -F %clientRoot% info)
</code></p>
<h2>Procedure</h2>
<h3>Step 1: Plan!</h3>
<p>Use <a href="https://perforce.atlassian.net/jira/software/c/projects/SDP/issues">this JIRA Project</a> to plan your work. This JIRA instance is only accessible with Perforce corporate SSO.</p>
<p>The SDP product owner determines what the release will be. For example <strong>2025.1</strong> would be the <strong>SDP 2025.1, GA Release</strong>, while <strong>2025.1.1</strong> would be <strong>SDP 2025.1 Patch 1</strong>.</p>
<p>The SDP shares the same major version as P4 Server (e.g. 2025.1). Versions in JIRA use the major version number, and append an integer as the patch identifier. The patch number is omitted for the GA release, and increments starting from 1 for each patch after a major release. While SDP major releases are bound to the P4D release schedule, SDP patches release on an independent schedule.</p>
<p>In JIRA, create Releases to be used for <code>Fix version</code> identifiers, such as 2024.2, 2024.2.1, 2025.1, etc. The name of the release should following YYYY.M for a major release, or YYYY.M.P for a patch release.</p>
<p>For example, in JIRA, there will be a release named 2024.2.3, with a Description of "SDP 2024.2 Patch 3", and a 2025.1 release with a description of "SDP 2025.1."</p>
<p>Create JIRA search filters for each <code>Fix version</code>, e.g. <code>2025.1</code> for the SDP 2025.1 GA release, or <code>2024.2.3</code> for the SDP 2024.2 Patch 3 release. There is also a standing <code>SDP To Do</code> filter with all open jobs used during planning.</p>
<p>Generally, while some planning occurs early in the release cycle, other elements of planning occur iteratively and continuously throughout the SDP release cycle.</p>
<p><strong>Output</strong>: The output of this step is a set of JIRA issues associated with <code>Fix versions</code>.</p>
<h3>Step 2: Develop!</h3>
<p>Develop and test changes, either directly in <code>dev</code> (for small, low-risk, or hyper-urgent changes) or in a short-lived <code>dev_*</code> stream parented by <code>dev</code> (for larger or higher-risk changes), merged into <code>dev</code> once ready. This will occur over time.</p>
<p>When an issue is marked as complete, do the following in JIRA to get it included in the Release Notes:</p>
<ul>
<li>Set the <code>Fix versions</code> JIRA issue field value to the next release, e.g. <code>2024.2</code>.</li>
<li>Update the <code>P4Blog</code> field of the JIRA issue with an indication of what change addressed the issue. This can be a review URL from The Workshop, e.g. https://workshop.perforce.com/reviews/29811, or could also be the URL for the changelist in <code>//p4-sdp/dev</code> (or the <code>dev_*</code> stream) where the fix was made.</li>
</ul>
<p><strong>Output</strong>: The output of this step is an improved software product and information needed to create release notes.</p>
<h3>Step 3: Target New P4D in SDP Regression Test Suite (Major Releases Only)</h3>
<p>This step applies to major releases only; skip this for patch releases. Done in the <code>dev</code> client, as part of ongoing development (not release-time-specific).</p>
<p>Update the SDP regression test suite to ensure that it references the new P4 Server release. For example, <code>Server/test/test_Upgrade.py</code>'s <code>--to-version</code> default argument needs updating to the new release (e.g. from <code>"24.2"</code> to <code>"25.1"</code>).</p>
<p>This code change might possibly break the regression. It is important to re-verify that the regression test suite is still successful after this change, adapting as needed.</p>
<p><strong>Output</strong>: This step ensures the new P4 Server version doesn't break SDP regression tests suites, and to raise awareness of any issues that may cause customer issues when adopting the new release.</p>
<h3>Step 4: Verify SDP Regression Tests</h3>
<p>Verify that all SDP regression test suites are successful, targeting <code>//p4-sdp/dev</code> (the release candidate) -- not <code>main</code>, which won't have this release's content until Copy Up happens later in this process. After Copy Up and cutting the release stream (later steps), do a final, lighter-weight spot check of the same suites against the new release stream itself, since real content moves at that point.</p>
<h4>Regression Test Suite 1: Docker/Jenkins</h4>
<p>The first test suite is the Docker-based test suite with a Jenkins server running and polling for changes.</p>
<p>The SDP regression test suite Jenkins job is only accessible from the Perforce corporate VPN.</p>
<p>This uses files in <code>//p4-sdp/dev/test/...</code> (except the <code>bsw</code> subdirectory) and <code>//p4-sdp/dev/Server/test</code>.</p>
<h4>Regression Test Suite 2: Dedicated Battle School Workshop (BSW)</h4>
<p>The second test suite is the Battle School Workshop test suite, which operates in a dedicated Battle School Workshop Lab Environment (Gen 7).</p>
<p>This uses files in <code>//p4-sdp/dev/test/bsw/...</code></p>
<p>Tests are run via the lab's <code>qa</code> alias (or <code>qa_build</code> for a fully automated, unattended run), which syncs the lab's insitu SDP checkout and then runs <code>run_all_tests.sh</code> against it. The tests themselves are defined in <code>cli_tests.cfg</code> and <code>scripted_tests.cfg</code> in <code>test/bsw</code>. See <code>SDP-QA-LabEnvironment.adoc</code> (in the Gen7 lab project) for the full mechanism.</p>
<h4>Regression Test Suite 3: The install_sdp.sh test servers</h4>
<p>A fleet of EC2 instances of various operating systems ensures that the <code>install_sdp.sh</code> script and its dependencies run on a variety of supported Linux distros. This fleet, in AWS region us-east-2, is home to the dedicated test suite for the <code>install_sdp.sh</code> script. For optimal realism, these do not run in containers.</p>
<p><strong>Two fleets currently exist</strong> -- an old one whose DVCS remotes still point at stale Classic-depot guest paths, and the correct, current one whose remotes point at the real <code>//p4-sdp/...</code> streams. Always use the current fleet (identifiable by its <code>ssh-test-install_sdp-*</code> wrapper scripts, as opposed to the old fleet's <code>ssh-install_sdp-test*</code> wrappers). See the <code>install-sdp-test-suite-run</code> skill for the full fleet inventory and how to tell them apart reliably.</p>
<p>The following operating systems are currently represented in the current fleet:</p>
<ul>
<li>Rocky 8</li>
<li>Rocky 9</li>
<li>Rocky 10</li>
<li>SuSE 15</li>
<li>Ubuntu 22.04</li>
<li>Ubuntu 24.04</li>
<li>Ubuntu 26.04 (aarch64) -- known NOT to work due to a POSIX <code>chown</code> compliance regression that the Ubuntu community has not yet addressed; a failure here is not by itself a sign of a new regression.</li>
</ul>
<p><strong>Output</strong>: The output of this step is confidence we're not regressing.</p>
<h3>Step 5: Determine Release Type</h3>
<p>Determine if the SDP release is to be Major, Patch, or Doc Only.</p>
<p>Since the 2021.2 release of P4D, SDP major releases have been tied to the P4D release schedule, <strong>with SDP releases occurring approximately 10-15 business days after P4D releases</strong>.</p>
<p>Other releases will be Patch releases if there are any functionality changes, or Doc Only releases, where changes since the last release affect only documentation. The SDP documentation is key to its value, worth doing patch updates including only documentation changes.</p>
<p>Regardless of Major or Patch, the release mechanics in this document are identical: both are cut as a fresh release stream from <code>main</code> (e.g. <code>r26.1.0</code> for GA, <code>r26.1.1</code> for the first patch after it). Only a small number of steps below are marked "Major Releases Only."</p>
<p><strong>Output</strong>: The output of this step is an intended SDP major version number and type, e.g. "2024.2 Patch 3", or "2025.1 GA".</p>
<h3>Step 6: Update Default P4D Version (Major Releases Only)</h3>
<p>This step applies to major releases only; skip this for patch releases. Done in the <code>dev</code> client, as an ordinary development change.</p>
<p>Modify the script <code>$WSRoot/p4_binaries/get_p4_binaries.sh</code> as follows:</p>
<ul>
<li>Change the <code>DefaultP4Version</code> value to match the current P4 Server GA release version with a value like <code>r25.1</code>. The binaries for this release should be accessible under https://ftp.perforce.com/perforce/r25.1 (replacing <code>r25.1</code> with the new value).</li>
</ul>
<p><strong>Output</strong>: The default P4 Server version acquired from our FTP server with the <code>get_p4_binaries.sh</code> script reflects the new major version for the P4 Server.</p>
<h3>Step 7: Update P4*.json release list files (Major Releases Only)</h3>
<p>This step applies to major releases only; skip this for patch releases. Done in the <code>dev</code> client, as an ordinary development change.</p>
<p>Edit the <em>P4</em>.json release list files used by <code>get_p4_binaries.sh</code>.</p>
<p><code>
cd "$WSRoot/p4_binaries"
p4 edit P4*.json
for jf in P4 P4D P4Broker P4Proxy; do
curl -O "https://updates.perforce.com/static/${jf}/${jf}.json"
p4 diff "${jf}.json"
done
</code></p>
<p>Verify the contents of the downloaded *.json files contain valid JSON content. Then submit:</p>
<p><code>
p4 submit -d "Updated JSON files" "P4*.json"
</code></p>
<p><strong>REMINDER</strong>: The <code>DefaultP4Version</code> changes <em>only</em> for GA releases, not patches. Also, the P4*.json files need only be updated for major releases.</p>
<p>JIRA issue bookkeeping (updating <code>Fix versions</code>/<code>P4Blog</code>, ensuring issues are closed, drafting release-notes content) is ongoing work done throughout the release cycle per Steps 1 and 2 -- see the "Update Release Notes" step below for the actual release-notes authoring, which happens once, later in this process, after Copy Up.</p>
<p><strong>Output</strong>: The output of this step is that the <code>get_p4_binaries.sh</code> script has the latest information on which platforms/architectures are supported by the new P4D version, which is contained in those json files. For example, those files know whether aarch64 (for Graviton processors) is available for a given p4d version.</p>
<h3>Step 8: Load Release Tools</h3>
<p>In whichever release workspace client you're currently working from (<code>dev</code>, <code>main</code>, or the release stream once cut), load that stream's own copy of the release tooling:</p>
<p><code>
cd "$WSRoot/tools"
p4 -s sync
source ./env.sh
</code></p>
<p>Since <code>tools/</code> now lives inside each stream, this needs to be done once per client you switch into during the process, not just once globally.</p>
<p><strong>Output</strong>: The shell environment now has needed tools in the PATH.</p>
<h3>Step 9: Merge Down</h3>
<p>Ensure <code>dev</code> is updated from <code>main</code>, from the <strong><code>dev</code> client</strong>.</p>
<p>This ensures any hot fixes that may have been made directly in <code>main</code> are considered for incorporation in the formal release. Streams tracks <code>dev</code>'s parent (<code>main</code>) automatically, so no branch spec is needed:</p>
<p><code>
cd "$WSRoot"
p4 merge -n
</code></p>
<p>If there is anything to merge, take care of it in your regular SDP development workspace, not the release workspace. If needed, file new JIRA issues and reference them in the changelist description. Upon completion of any needed merge work, re-run <code>p4 merge -n</code> to confirm it's now clean, then do the real merge (<code>p4 merge</code>), resolve, and submit.</p>
<p>Note: Any hot fixes should generally be merged down immediately after the hot fix is complete, so that this check is just a formality. No actual merge work is expected during the release process. If merge work is required, regression test suites will need to be re-verified.</p>
<p><strong>Output</strong>: This is the start of the "Merge Down, Copy Up" process, essential to any release process. It ensures any bugs fixed by emergency hot fixes (i.e. those made directly in <code>main</code>) don't rear their ugly heads to haunt future releases, including the current one in progress.</p>
<h3>Step 10: Copy Up</h3>
<p>Push <code>dev</code>'s content up into <code>main</code>, from the <strong><code>main</code> client</strong>.</p>
<p><code>
cd "$WSRoot"
p4 copy -S //p4-sdp/dev
</code></p>
<p>This is an all-or-nothing operation for the whole tree: we don't want a partial release. Proceed <em>immediately</em> to the next step once submitted -- everything from here through packaging is done in <code>main</code>, using <code>dev</code>'s just-copied-up content as the release candidate.</p>
<p><strong>WARNING FOR PARTIAL RELEASES</strong>: If this is to be a partial release, revert any files that are not ready to be released before submitting the Copy Up changelist, and defer the corresponding JIRA issues' <code>Fix versions</code>. Given <code>dev</code> is meant to always be release-ready, this should be a rare, exceptional case, not the norm.</p>
<p><strong>Output</strong>: This is the end of the "Merge Down, Copy Up" process. At this point, <code>main</code> has all of the content for the new release, and every remaining step through packaging operates on <code>main</code>.</p>
<h3>Step 11: Update Doc Versions (Major Releases Only)</h3>
<p>This step applies to major releases only; skip this for patch releases. Done in the <strong><code>main</code> client</strong>.</p>
<p>Update AsciiDoc <code>revnumber</code> and <code>revdate</code>.</p>
<p>In all *.adoc files, verify that the <code>:revnumber:</code> and <code>:revdate:</code> tags in the file refer to the correct SDP release version and date the file was last modified -- updating it to the current date. The *.adoc files appear in the <code>doc</code> folder as well as the <code>Unsupported/doc</code> folder; ensure both are updated.</p>
<p>The fields look something like this example in each *.adoc file:</p>
<p><code>
:revnumber: v2025.2
:revdate: 2026-07-21
</code></p>
<p>This can be done like so:</p>
<p>```
cd "$WSRoot"
ThisWorkspace=$(p4 set -q P4CLIENT|cut -d= -f2)
ThisStream=$(p4 -ztag -F %Stream% client -o "$ThisWorkspace")
RevNum=2026.1
RevDate=$(date +'%Y-%m-%d')</p>
<p>p4 --field Description="Updated revnumber and date for release." --field Jobs= --field Files= change -o | p4 change -i
CL=$(p4 -ztag -F %change% changes -s pending -c $ThisWorkspace -m1)</p>
<p>{ for df in $(p4 -ztag -F %depotFile% grep -e :revnumber: "$ThisStream/doc/<em>.adoc" "$ThisStream/Unsupported/doc/</em>.adoc"); do f="$(p4 -ztag -F %path% where $df)"; echo -e "\nFile=$f"; p4 edit -c $CL "$f"; sed -i -E -e "s|^:revnumber:.<em>|:revnumber: v$RevNum|g" -e "s|^:revdate:.</em>|:revdate: $RevDate|g" "$f"; p4 diff "$f"; p4 revert -a "$f"; done; p4 describe -s $CL; } 2>&1 | tee /tmp/docup.log
```</p>
<p>Review documents for any outdated references or content.</p>
<p>At this point all *.adoc files will be opened in the default changelist. Generate a pending changelist:</p>
<p><code>
p4 --field Description="Updated rev{number,date} fields in adoc files for release." change -o | p4 change -i
</code></p>
<p>Review the generated pending changelist, and submit. Ensure before submitting that the changelist contains only the *.adoc files.</p>
<p><code>
p4 -s submit -c $CL
</code></p>
<p><strong>Output</strong>: Help prevent documentation from being outdated.</p>
<h3>Step 12: Update TAG Refs in SDP Upgrade Script</h3>
<p>This step applies to any release (major or patch) in which changes to the <code>p4_vars.template</code> or <code>instance_vars.template</code> files were made. Skip this for patch releases in which no changes to templates were made. Done in the <strong><code>main</code> client</strong>.</p>
<p>To verify whether changes are were made to the SDP Environment File since the last release or patch, do:</p>
<p>```
cd "$WSRoot"
LastReleaseCL=$(p4 print -q //p4-sdp/main/Version|cut -d '/' -f 4|cut -d ' ' -f 1)</p>
<p>p4 changes //p4-sdp/main/Server/Unix/p4/common/config/p4_vars.template@$LastReleaseCL,@now</p>
<p>p4 changes //p4-sdp/main/Server/Unix/p4/common/config/instance_vars.template@$LastReleaseCL,@now
```</p>
<p><strong>If no changes were made, skip to the next step</strong>. Otherwise, modify the script <code>$WSRoot/Server/Unix/p4/common/sdp_upgrade/sdp_upgrade.sh</code> as follows:</p>
<ul>
<li>Use the <code>gen_file_format_check.sh</code> script to check. If this reports that versions match, <strong>you are done, move on to the next step.</strong>. Otherwise, continue ...</li>
<li>Open the script for edit and modify it.</li>
<li>Change the <code>Version=</code> value, incrementing the 3rd digit by one. So if the current value is <code>1.6.4</code>, increment to <code>1.6.5</code>.</li>
<li>Search the file for <code>TAG:</code> comments.</li>
<li>Update <code>SDPEnvFileNewFormatVersion</code> if the format of the SDP Environment File <code>p4_vars</code> changed since the last release or patch.</li>
<li>Update <code>SDPInstanceCfgFileNewFormatVersion</code> if the template for the Instance Config File changed since the last release or patch.</li>
<li>Update the <code>SDPTargetMajorVersion</code> to the new version about to be released (Major Releases Only).</li>
<li>Submit a new version of <code>sdp_upgrade.sh</code> when done if changes were needed to the <code>*FormatVersion*</code> or <code>SDPTargetMajorVersion</code> strings. If it turned out no changes were needed, revert the file (undoing the version number change).</li>
</ul>
<p>TIP: These template version tags are important as they affect what format versions are displayed in the log when <code>sdp_upgrade.sh</code> runs. However, the upgrade script always regenerates files using the correct/latest available versions of the templates in the release.</p>
<p><strong>Output</strong>: The output of this step is that SDP Upgrades using the new version display correct output about updates to generated files such as <code>p4_vars</code> and the Instance Vars file(s).</p>
<h3>Step 13: Generate Script Docs</h3>
<p>This step applies to any release (major or patch). Done in the <strong><code>main</code> client</strong>.</p>
<p>Ensure generated documentation is current.</p>
<p><code>
cd "$WSRoot/doc/gen"
./gen_script_man_pages.sh -submit
</code></p>
<p>Observe the output. It may or may not create a new changelist in <code>doc/gen/...</code>, depending on whether the various scripts have changed since docs were last generated for them.</p>
<p>This script runs scripts with the <code>-man</code> option and stores that in a file, which is then included in <code>SDP_Guide.Unix.adoc</code>.</p>
<p>Note: files under <code>doc/gen/*.man.txt</code> (and <code>doc/gen/sdp_install.cfg</code>) are <code>isolate</code>d on <code>//p4-sdp/main</code> -- this changelist stays local to whichever stream you submit it in and never flows via Merge Down/Copy Up. That's deliberate: each stream regenerates its own copy independently, avoiding merge conflicts on generated content. It also means this step needs repeating in the release stream once it's cut (see below), since script versions (derived from <code>$Id:$</code>/<code>$Change:$</code> RCS keywords) differ per stream even when the underlying script content is identical.</p>
<p><strong>Output</strong>: The output of this step is that documentation generated from shell scripts is current with respect to their corresponding source files.</p>
<h3>Step 14: Generate HTML and PDF Docs</h3>
<p>NOTE: For the following to work, you will need some utilities, including <code>asciidoctor</code>, <code>asciidoctor-pdf</code>, and <code>markdown</code>.</p>
<p>Generate HTML and PDF files from the AsciiDoc (<code>*.adoc</code>) and Markdown files (<code>*.md</code>). Done in the <strong><code>main</code> client</strong>.</p>
<p><code>
cd "$WSRoot/doc"
make clean all
p4 rec
cd "$WSRoot/Unsupported/doc"
make clean all
p4 rec
p4 --field Description="Regenerated docs for release." change -o | p4 change -i
</code></p>
<p>Review the generated pending changelist. Ensure before submitting that the changelist contains only expected files, generally *.html and *.pdf files.</p>
<p>If all is well the then use the command below with the appropriate changelist number
<code>
p4 -s submit -c #####
</code></p>
<p>Note: like <code>doc/gen/*.man.txt</code>, all of <code>doc/*.html</code>, <code>doc/*.pdf</code>, <code>Unsupported/doc/*.html</code>, and <code>Unsupported/doc/*.pdf</code> are <code>isolate</code>d on <code>//p4-sdp/main</code> -- same reasoning as Step 13, and same requirement to repeat this step in the release stream once it's cut.</p>
<p><strong>Output</strong>: All documentation is the consumable formats (HTML, PDF) are current with respect to the source formats (Markdown, AsciiDoc).</p>
<h3>Step 15: Update SDP Version File</h3>
<p>Done in the <strong><code>main</code> client</strong>, after Copy Up (Step 10) -- by this point <code>main</code> already has all of <code>dev</code>'s latest content, so this step operates entirely on <code>main</code>.</p>
<p><code>
cd "$WSRoot/tools"
./preview_changes_and_update_version.sh 2>&1 | tee /tmp/preview.log
</code>
This script will prompt for the major release version, e.g. <code>2024.2</code>.</p>
<p>It will also checkout and display the change it proposes to make to the Version file, something like this:</p>
<p>```
Updating /Users/ttyler/re/p4-sdp/main/Version file.
//p4-sdp/main/Version#152 - opened for edit
==== //p4-sdp/main/Version#152 - /Users/ttyler/re/p4-sdp/main/Version ====
1c1</p>
<h2>< Rev. SDP/MultiArch/2025.1/37000 (2025/05/15).</h2>
<blockquote>
<p>Rev. SDP/MultiArch/2025.2/38000 (2005/12/01).
```</p>
</blockquote>
<p>Review the <code>/tmp/preview.log</code> to make sure no significant changes were excluded from the release notes.</p>
<p>If the diff of the Version file looks reasonable, proceed.</p>
<p>TIP: The date of the release is the date of the last submit to <code>main</code> at this point (i.e. right after Copy Up). Historically and typically this is the same as the date this release process is exercised, but there can be some lag between the last submit and the shipping of the release.</p>
<p>Note: <code>Version</code> is <code>isolate</code>d on <code>//p4-sdp/main</code>, so this file's history is intentionally independent per stream -- it is never merged or copied between streams, only ever directly edited and submitted in whichever stream needs a new marker (here, <code>main</code>; later, the release stream will get its own once cut).</p>
<p><strong>Output</strong>: The output of this step is that SDP Version file is updated. At this point we know the changelist number and date to be associated with the new SDP release.</p>
<h3>Step 16: Update Release Notes</h3>
<p>Done in the <strong><code>main</code> client</strong>.</p>
<p>Open the <code>ReleaseNotes.*</code> files for edit. In <code>ReleaseNotes.adoc</code>, review the titles of the "What's New" sections and update as needed, removing obsolete info and adding a very short summary of the theme of what's included in this new release.</p>
<p>Then update the <strong>Change History</strong> section, by adding a new section titled something like <strong>SDP 2024.2 Patch 3</strong> to include the list of JIRA issues fixed since the last SDP release or patch.</p>
<p>When editing, follow examples from earlier releases in the file. In particular, a section of the file will looks something like this snippet, which includes the content of the <code>Version</code> file generated in the previous step:</p>
<p>```</p>
<p>== Change History</p>
<p>=== SDP 2024.2 Patch 3:</p>
<p>Released: Rev. SDP/MultiArch/2024.2/31367 (2025/03/23).</p>
<p>Jobs Fixed since change 31193 up to 31367 (B=Bug, D=Doc, F=Feature):</p>
<ul>
<li>https://perforce.atlassian.net/browse/SDP-1218[SDP-1218] (B): mkdirs.sh overwrites existing crontab when adding multiple instances.</li>
<li>https://perforce.atlassian.net/browse/SDP-1217[SDP-1217] (B): Adjust perforce_bashrc template to avoid setting HISTFILE if it is readonly.</li>
</ul>
<p>... and so on ...
```</p>
<p>To get the list of JIRA issues, run a JIRA report of SDP issues with the target <code>Fix versions</code>, e.g. <code>2024.2.3</code>, and ensure all issues listed in the report are considered for inclusion in the release notes.</p>
<p>It is also a good idea to run a report of all open JIRA issues, to include those with an unassigned or different value for <code>Fix versions</code>, and consider if they could or should be included in the current release.</p>
<p>We don't need a JIRA issue for every change. Create JIRA issues to cover the essentials of what changed. Folks who want the gory details can look at changelists, but folks looking only at the release notes should get a useful summary of what's new in this release or patch, and if appropriate, what to be aware of when upgrading to this release.</p>
<p>Some JIRA issues may be excluded from the public facing release notes if they're not helpful or relevant in helping a customer understand what changed.</p>
<p>Much of JIRA management work should be done during the development, mixed with work from Steps 1 and 2 above. At release time, this check should be a careful double-check to ensure release notes are complete and correct.</p>
<p>Then regenerate the ReleaseNotes.{html,pdf} files, and review them visually to ensure they look good and contain necessary info.</p>
<p><code>
make ReleaseNotes.{html,pdf}
</code></p>
<p>At this point, there should be a changelist with these files checked out:</p>
<p><code>
$ p4 opened
//p4-sdp/main/Version#152 - edit default change (text)
//p4-sdp/main/doc/ReleaseNotes.adoc#104 - edit default change (text)
//p4-sdp/main/doc/ReleaseNotes.html#86 - edit default change (text)
//p4-sdp/main/doc/ReleaseNotes.pdf#64 - edit default change (binary)
</code></p>
<p>As a final double-check, bing up the JIRA release and make sure all associated issues are marked as done and completed. If any are not done or not indicated as done, we need to make corrective actions. Actions may include:</p>
<ul>
<li>Updating JIRA issues status to match reality, e.g. closing an issue if the code has already been delivered and tested.</li>
<li>Updating reality to match JIRA reported issue status.</li>
<li>Deferring: change the <code>Fix versions</code> of any features that are to be deferred until a future release.</li>
</ul>
<p>Then submit:</p>
<p><code>
p4 submit -d "Updated Version and Release Notes."
</code></p>
<p><strong>Output</strong>: The Version file and Release Notes are updated for the release, entirely within <code>main</code>.</p>
<h3>Step 17: Cut the Release Stream</h3>
<p>Create the new release stream from <code>main</code>, e.g. <code>//p4-sdp/r26.1.0</code> for a GA release, or <code>//p4-sdp/r26.1.1</code> for the first patch after it. This is the first step in this process with no Classic-era equivalent -- Classic had no per-release streams, <code>main</code> itself served as the release archive.</p>
<p>Template the new stream's spec from <code>main</code> (so it correctly inherits <code>main</code>'s Paths, including the <code>isolate</code> rules for generated content and for <code>ai_dev_support</code>/<code>Version</code>):</p>
<p><code>
p4 stream -o //p4-sdp/main | sed \
-e "s@^Stream:.*@Stream:\t//p4-sdp/r26.1.0@" \
-e "s@^Type:.*@Type:\trelease@" \
-e "s@^Parent:.*@Parent:\t//p4-sdp/main@" \
-e "s@^Name:.*@Name:\tr26.1.0@" \
| grep -v '^Update:\|^Access:' \
| p4 stream -i
</code></p>
<p>(Replace <code>r26.1.0</code> with the actual release name being cut.)</p>
<p>Populate the new stream's initial content wholesale from <code>main</code>:</p>
<p><code>
p4 populate -S //p4-sdp/r26.1.0 -d "Initial population of r26.1.0 from main."
</code></p>
<p>Then create a new release workspace client switched to it (e.g. rooted at <code>~/re/p4-sdp/r26.1.0</code>) and sync it.</p>
<p><strong>Output</strong>: A new, long-lived, stable release stream exists, holding a snapshot of everything in <code>main</code> as of this release.</p>
<h3>Step 18: Final Regen in the Release Stream</h3>
<p>Done in the <strong>new release stream's client</strong>.</p>
<p>Because script versions are derived from <code>$Id:$</code>/<code>$Change:$</code> RCS keywords (see the SDP Bash Coding Standard's Version Identification section), the same script's version string differs between <code>main</code> and the just-cut release stream, even though the content is identical -- submitting/populating a file into a new stream changes its <code>$Change:$</code> value. Since <code>doc/gen/*.man.txt</code>, <code>doc/*.html</code>, <code>doc/*.pdf</code>, and their <code>Unsupported/doc</code> equivalents are all <code>isolate</code>d (see Steps 13-14), they were never copied into the release stream by the populate above with correct version strings -- they need regenerating here, once, in the release stream itself:</p>
<p>```
cd "$WSRoot/doc/gen"
./gen<em>script</em>man_pages.sh -submit</p>
<p>cd "$WSRoot/doc"
make clean all
p4 rec
cd "$WSRoot/Unsupported/doc"
make clean all
p4 rec
p4 --field Description="Final doc regen for r26.1.0." change -o | p4 change -i
```</p>
<p>Review and submit the resulting changelist, same as Steps 13-14.</p>
<p>If a bookmarked link to <code>main</code>'s docs shows "MAIN" in a script's version tag rather than a release number, that's expected and correct, not a bug -- it's an honest signal that the reader is viewing the rolling <code>main</code>, not a specific release.</p>
<p><strong>Output</strong>: The release stream's own generated documentation correctly reflects its own release-tagged script versions, not <code>main</code>'s.</p>
<h3>Step 19: Package</h3>
<p>Package the release by creating the tarball. Done in the <strong>release stream's client</strong> for a GA/patch release, or the <strong><code>dev</code> client with <code>-P</code></strong> for a pre-release build.</p>
<p><code>
cd "$WSRoot/tools"
bash package_downloads.sh
</code></p>
<p>See the macOS note in "Preparation" above -- this script needs bash 4.x+; if a plain <code>bash</code> on your PATH still resolves to macOS's system one, invoke your modern bash explicitly instead (e.g. <code>/opt/homebrew/bin/bash package_downloads.sh</code>).</p>
<p>The <code>package_downloads.sh</code> script puts tar and zip files into the <code>downloads</code> folder (excluded from the package itself, along with <code>tools/</code> and <code>ai_dev_support/</code>), and removes older versions.</p>
<p>Review and submit the generated changelist manually. In the output of the script, you should see a message illustrating the exact command you need, something like:</p>
<p><code>
To complete packaging, run:
p4 -s submit -c 31370
</code></p>
<p>Note: <code>downloads/</code> is <code>isolate</code>d on <code>//p4-sdp/main</code> -- this changelist stays local to the release stream and never flows via Merge Down/Copy Up. That's deliberate: a pre-release (<code>-P</code>) build in <code>dev</code> must never leak into <code>main</code> via ordinary Copy Up, and each stream's tarball is a build artifact, not source content. This is also why the next step exists.</p>
<p><strong>Output</strong>: The new SDP tarball exists in the release stream, ready to be published to its permanent, version-independent download location.</p>
<h3>Step 20: Publish the Tarball to <code>main</code></h3>
<p>Done in the <strong><code>main</code> client</strong>, immediately after Step 19.</p>
<p><code>install_sdp.sh</code> deliberately downloads the SDP tarball from a fixed, permanent URL under <code>main</code> (<code>.../download/p4-sdp/main/downloads/sdp.Unix.tgz</code>), not from any specific release stream's own URL -- this mirrors the single fixed download location the Classic depot always had, and means <code>install_sdp.sh</code> never needs a URL edit for a future release. Since <code>downloads/</code> is <code>isolate</code>d, Copy Up (Step 10) does <strong>not</strong> carry the new tarball into <code>main</code> -- <code>main</code>'s <code>downloads/</code> still holds the <em>previous</em> release's real tarball at this point, which is exactly why nothing was ever broken earlier in this process: that fixed URL has been resolving to a real, working (if not-yet-current) tarball the entire time. This step is what makes it current:</p>
<p><code>
cd "$WSRoot/tools"
cp "$OtherWSRoot/downloads/"*.{tgz,zip} downloads/
p4 add -f downloads/*.tgz downloads/*.zip 2>/dev/null; p4 edit downloads/*.tgz downloads/*.zip 2>/dev/null
p4 --field Description="Publish r26.1.0's tarball to main's permanent download location." change -o | p4 change -i
</code></p>
<p>(Replace <code>$OtherWSRoot</code> with the release stream client's root from Step 19, and remove any older-version-named files from <code>main</code>'s <code>downloads/</code> first, matching <code>package_downloads.sh</code>'s own "removes older versions" behavior.)</p>
<p>Review the generated pending changelist -- it should contain only the tarball/zip files, with no version-stamped duplicates left behind from prior releases -- then submit.</p>
<p><strong>Output</strong>: <code>main</code>'s fixed, permanent download URL now serves the new release's tarball. At no point during this entire process did that URL ever stop resolving to a real, working tarball -- it simply switched from serving the previous release to serving this one. This completes the public aspects of the release process.</p>
<h3>Step 21: Release in JIRA</h3>
<p>Set the date for the release in JIRA, and then execute the Release action.</p>
<p><strong>Output</strong>: Information in JIRA is correct. This completes the internal tracking of the release process.</p>
<h3>Step 22: Post-Release Smoke Tests</h3>
<p>Done immediately after release, outside of any release workspace client -- these are manual, real-world exercises, not automation.</p>
<ol>
<li><p><strong>Fresh install, from scratch.</strong> Build a fresh VM and follow the documented install-from-scratch procedure using <code>install_sdp.sh</code>, exactly as a new customer would. This tests the docs and the script together, not just the script in isolation. After install, exercise a couple of the everyday admin scripts by hand -- e.g. <code>live_checkpoint.sh</code> and <code>daily_checkpoint.sh</code> -- to confirm the installed result actually works day to day, not just that the installer exited cleanly.</p></li>
<li><p><strong>Real upgrade, dogfooded.</strong> Pick an existing live SDP environment and execute the documented upgrade procedure against it for real. This isn't really a test at this point -- it's dogfooding: upgrading a production environment (e.g. the PPN or Public Depot servers) immediately after the release ships, or upgrading a Gen6 lab environment running an older SDP release. Like the fresh install, this exercises the docs and automation together, using the same procedure a real customer would follow.</p></li>
</ol>
<p><strong>Output</strong>: Confidence that the release actually works end-to-end in real environments, as documented, not just in the automated regression suites.</p>
| # | Change | User | Description | Committed | |
|---|---|---|---|---|---|
| #1 | 33447 | Claude (AI Agent by Anthropic) |
Final doc regen for r26.1.0.BETA (release process Step 18). Agent: Claude Code, Model: Claude Sonnet 5 (claude-sonnet-5), operating as bot_Claude_Anthropic. |