Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-16 12:56:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update security.md and release process

Browse source
This commit is contained in:
Griatch 2024-03-31 11:58:31 +02:00
parent 818ab25b27
commit a481cb4b2b
2 changed files with 9 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

13
.release.sh
View file

@ -9,13 +9,14 @@ 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 '[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 " b. Update 'SECURITY.md' with latest new version."
echo " c. Make sure all changes are committed, e.g. as 'Evennia $VERSION major/minor/patch release'."
echo " d. Check out a new branch v$VERSION."
echo " e. Push the v$VERSION branch to github."
echo " f. 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 '[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 " g. Rename the created build/html folder to '[MAJOR_VERSION].x'. Manually copy it to the gh-pages branch's build/ folder."
echo " h. 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 (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!"

3
SECURITY.md
View file

@ -7,7 +7,8 @@ to use the latest minor/patch version within each major version.
| Version | Supported |
| ------- | ------------------ |
| 3.x | :white_check_mark: |
| 4.x | :white_check_mark: |
| 3.x | :x: |
| 2.x | :x: |
| 1.x | :x: |
| < 1.0 | :x: |