Evennia 2.0.0 major release

.release.sh

@@ -5,11 +5,20 @@ VERSION=$(cat evennia/VERSION.txt)
 echo "This will release Evennia $VERSION (based on evennia/VERSION.txt)."
 echo "Before continuing:"
 echo " 1. Make sure you have Evennia upload credentials for Github (tagging) and PyPi (main package)."
-echo " 2. Update CHANGELOG.md."
-echo " 3. Make sure pyproject.toml is set to the same version as evennia/VERSION.txt ($VERSION)."
-echo " 4. Run 'make local' in docs/ to update dynamic docs (like Changelog.md) and autodocstrings (may have to run twice)."
-echo " 5. Make sure all changes are committed, e.g. as 'Evennia $VERSION major/minor/patch release' (un-staged files will be wiped)."
-echo " 6. Make sure all unit tests pass!"
+echo " 2. On main branch, update CHANGELOG.md."
+echo " 3. Make sure pyproject.toml is set to the same major.minor.patch version as evennia/VERSION.txt ($VERSION)."
+echo " 4. If major release:"
+echo "    a. Update docs/conf.py, set release to new major release, e.g. '3.x'. Add the previous latest major.minor.patch "
+echo "       release (LATEST_RELEASE) to the list of 'legacy_versions' to show as an old doc version."
+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 "    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)."
+echo " 7. Make sure all unit tests pass!"
 
 read -p "Continue? [Y/n]> " yn
 

CHANGELOG.md

@@ -26,6 +26,7 @@ June 10, 2023
   supports 3.11 on Windows.
 - Docs: New Beginner-Tutorial lessons for NPCs, Base-Combat Twitch-Combat and
   Turnbased-combat (note that the Beginner tutorial is still WIP).
+- Stabilize how to make the major update in the docs.
 - Fix: A lot of other minor bug fixes.
 
 

docs/source/Coding/Changelog.md

@@ -26,6 +26,7 @@ June 10, 2023
   supports 3.11 on Windows.
 - Docs: New Beginner-Tutorial lessons for NPCs, Base-Combat Twitch-Combat and
   Turnbased-combat (note that the Beginner tutorial is still WIP).
+- Stabilize how to make the major update in the docs.
 - Fix: A lot of other minor bug fixes.
 
 

evennia/VERSION.txt

@@ -1 +1 @@
-2.0
+2.0.0