Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Evennia 4.0.0 major release

Browse source
This commit is contained in:
Griatch 2024-03-17 14:03:15 +01:00
parent 5e8a75ac8b
commit e25ee5d29c
6 changed files with 20 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

8
.release.sh
View file

@ -8,16 +8,16 @@ 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/sources/conf.py, Add '(NEW_VERSION).x' to 'legacy_versions' and 'v($VERSION)' to 'legacy_branches'."
echo " b. Make sure all changes are committed."
echo " a. Update docs/sources/conf.py, Add '[MAJOR_VERSION].x' to 'legacy_versions' and 'v$VERSION' to 'legacy_branches'."
echo " b. Make sure all changes are committed, e.g. as 'Evennia $VERSION major/minor/patch release'."
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 " f. Rename the created build/html folder to '[MAJOR_VERSION].x'. 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 " 6. Make sure all changes are committed (if not already), 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