From 2ee63f68f17f7782cb4a964ff4957b5da4432254 Mon Sep 17 00:00:00 2001
From: Griatch <griatch@gmail.com>
Date: Sat, 10 Jun 2023 10:59:54 +0200
Subject: [PATCH] Update release procedure help text

---
 .release.sh | 21 +++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)

diff --git a/.release.sh b/.release.sh
index ede6009e65..f8a1da0850 100755
--- a/.release.sh
+++ b/.release.sh
@@ -1,4 +1,4 @@
-# Release helper 
+# Release helper
 
 VERSION=$(cat evennia/VERSION.txt)
 
@@ -13,8 +13,9 @@ echo "       release (LATEST_RELEASE) to the list of 'legacy_versions' to show a
 echo "    b. Make sure all changes are committed."
 echo "    c. Check out a new branch vLATEST_RELEASE and reset it to the commit of the latest major.minor.patch release."
 echo "    d. Push the vLATEST_RELEASE BRANCH to github."
-echo "    e. On the vLATEST_RELEASE branch (re)build the docs for this release with 'make local'."
-echo "    f. Rename the resulting build folder to LATEST_RELEASE and manually copy it to the gh-pages branch's build/ folder."
+echo "    e. On the vLATEST_RELEASE branch, temporarily set 'current_is_legacy=True' in source/conf.py, then (re)build "
+echo "       the docs for this release with 'make local' and old-version warning headers. Throw away git changes after."
+echo "    f. Rename the created build/html folder to LATEST_RELEASE. Manually copy it to the gh-pages branch's build/ folder."
 echo "    g. Add the folder, commit and push to the gh-pages branch. Then checkout main branch again."
 echo " 5. Run 'make local' in docs/ to update dynamic docs (like Changelog.md) and autodocstrings (may have to run twice)."
 echo " 6. Make sure all changes are committed, e.g. as 'Evennia $VERSION major/minor/patch release' (un-staged files will be wiped)."
@@ -28,13 +29,13 @@ case $yn in
     * ) echo "Starting release ...";;
 esac
 
-# clean and build the pypi distribution 
+# clean and build the pypi distribution
 echo "Preparing and Building PyPi package ..."
 rm -Rf dist/
-git clean -xdf	
-pip install --upgrade pip 
-pip install build twine 
-python -m build --sdist --wheel --outdir dist/ . 
+git clean -xdf
+pip install --upgrade pip
+pip install build twine
+python -m build --sdist --wheel --outdir dist/ .
 
 echo "Uploading PyPi package (requires PyPi credentials) ..."
 
@@ -45,9 +46,9 @@ echo "Creating and pushing release tag tag v$VERSION (requires GitHub credential
 git tag -a v$VERSION -m "Evennia release v$VERSION"
 git push --tags
 
-echo "... Release complete." 
+echo "... Release complete."
 echo ""
-echo "Post-release actions:" 
+echo "Post-release actions:"
 echo " 1. Make sure to push all commits."
 echo " 2. Update github discussions to report on release."
 echo " 2. Make post in discord #announcements channel pointing to discussion post."