Add maintainer requirements and document the basic release flow

micro-nova · Jan 9, 2025 · a55e7b3 · a55e7b3
1 parent 137ca70
commit a55e7b3
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/NEW_RELEASE.md b/NEW_RELEASE.md
@@ -0,0 +1,13 @@
+# Making a new pyamplipi release
+
+```bash
+# build the latest
+python -m build
+
+# upload to pypi test (go to the pypi test website and make sure everything looks right)
+twine upload -r testpypi dist/pyamplipi-${VERSION}*
+
+# upload to pypi
+twine upload dist/pyamplipi-${VERSION}*
+
+```
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,3 +1,4 @@
+build
 flake8>=6.0.0
 mypy>=0.991
 sphinx>=5.3.0
@@ -6,3 +7,4 @@ myst-parser>=1.0.0
 types-PyYAML
 types-requests
 types-tabulate
+twine