From cc82b4659dcc2a622aeb7d944f29713108f547ef Mon Sep 17 00:00:00 2001 From: Griatch Date: Wed, 20 Dec 2023 17:56:32 +0100 Subject: [PATCH] Update doc release procedure --- .release.sh | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.release.sh b/.release.sh index f8a1da0850..49069ea81f 100755 --- a/.release.sh +++ b/.release.sh @@ -8,12 +8,12 @@ echo " 1. Make sure you have Evennia upload credentials for Github (tagging) and 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 " a. Update docs/conf.py, Add $VERSION to the list of 'legacy_versions' so one can find the current state" +echo " of the docs for this release." 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, temporarily set 'current_is_legacy=True' in source/conf.py, then (re)build " +echo " c. Check out a new branch v$VERSION." +echo " d. Push the v$VERSION branch to github." +echo " e. On the v$VERSION 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."