Add RELEASE_CHECKLIST.md

This commit is contained in:
2024-11-09 12:47:07 -06:00
parent ca9ea5ec30
commit db260ecfa3
2 changed files with 9 additions and 0 deletions

View File

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## Added ## Added
- A release checklist to the `CHANGELOG.md` file, as a reminder for procedure.
- backend: `pwdlib[argon2]` for password hashing - backend: `pwdlib[argon2]` for password hashing
- backend: provided `LOG_JSON_FORMAT` and `LOG_LEVEL` environment variable defaults in `run.sh` development script - backend: provided `LOG_JSON_FORMAT` and `LOG_LEVEL` environment variable defaults in `run.sh` development script
- backend: `User` model, `Session` model with migration script - backend: `User` model, `Session` model with migration script

8
RELEASE_CHECKLIST.md Normal file
View File

@@ -0,0 +1,8 @@
# Release Checklist
1. Ensure `backend/pyproject.toml` and `frontend/package.json` have the correct version number for the upcoming release.
2. Ensure `CHANGELOG.md` contains all changes for the upcoming release, with the correct version number and date labeled.
- `Unreleased` section should not exist.
- The version should match `pyproject.toml` and `package.json`.
3. Ensure all tests pass locally, as well as the CI/CD pipeline.
4. Correct all linting errors and warnings.