Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-30 20:47:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update doc release procedure

Browse source
This commit is contained in:
Griatch 2023-12-20 17:56:32 +01:00
parent 85a0b0940d
commit cc82b4659d
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
.release.sh
View file

@ -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."