From a481cb4b2b10ed2da2110b4771f19754ef0c906c Mon Sep 17 00:00:00 2001 From: Griatch Date: Sun, 31 Mar 2024 11:58:31 +0200 Subject: [PATCH] Update security.md and release process --- .release.sh | 13 +++++++------ SECURITY.md | 3 ++- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/.release.sh b/.release.sh index b9e131d7e8..55da41b193 100755 --- a/.release.sh +++ b/.release.sh @@ -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!" diff --git a/SECURITY.md b/SECURITY.md index 6ddcce0bee..99517cd032 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -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: |