From e195bd7b7bc0a2667c267ba989f717a7838d00c1 Mon Sep 17 00:00:00 2001 From: Omar Farooq Date: Mon, 14 Sep 2026 18:49:55 +0500 Subject: [PATCH] docs: add release checklist --- docs/RELEASE_CHECKLIST.md | 45 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 docs/RELEASE_CHECKLIST.md diff --git a/docs/RELEASE_CHECKLIST.md b/docs/RELEASE_CHECKLIST.md new file mode 100644 index 0000000..35692e9 --- /dev/null +++ b/docs/RELEASE_CHECKLIST.md @@ -0,0 +1,45 @@ +# OhMyDB Release Checklist + +Use this checklist before publishing a new stable OhMyDB release. + +## Code quality + +- [ ] Focused tests pass +- [ ] Full test suite passes +- [ ] `python -m compileall -q sql_safety_proxy` passes +- [ ] `python -m pip check` passes +- [ ] `git diff --check` passes + +## Compatibility + +- [ ] `ohmydb --version` works +- [ ] Legacy `sql-safety-proxy --version` works +- [ ] PostgreSQL path is validated +- [ ] MySQL/MariaDB path is validated when affected +- [ ] Supported Python versions pass CI + +## Packaging + +- [ ] Wheel builds successfully +- [ ] Source distribution builds successfully +- [ ] `twine check` passes +- [ ] Fresh virtual-environment install succeeds + +## Docker + +- [ ] Image builds successfully +- [ ] CLI works inside the image +- [ ] Container runs as a non-root user + +## Release + +- [ ] Version references are updated +- [ ] Release notes summarize user-visible changes +- [ ] Release tag points to the intended `main` commit +- [ ] Release assets are uploaded +- [ ] SHA-256 checksums are generated +- [ ] GitHub release is marked stable when appropriate + +## Final verification + +After publishing, verify the release from a clean environment instead of relying only on the development checkout. \ No newline at end of file