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

Update release procedure help text

Browse source
This commit is contained in:
Griatch 2023-06-10 10:59:54 +02:00
parent 371fe32662
commit 2ee63f68f1
1 changed files with 11 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

5
.release.sh
View file

@ -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 " 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 " 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 " 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 " e. On the vLATEST_RELEASE branch, temporarily set 'current_is_legacy=True' in source/conf.py, then (re)build "
echo " f. Rename the resulting build folder to LATEST_RELEASE and manually copy it to the gh-pages branch's build/ folder." 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 " 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 " 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, e.g. as 'Evennia $VERSION major/minor/patch release' (un-staged files will be wiped)."