|
| 1 | +#Maintainers Guide |
| 2 | + |
| 3 | +##Manual Release Process (PyPI) |
| 4 | +Automated PyPI workflow has been removed. Follow these steps to cut a release: |
| 5 | + |
| 6 | +1. Update version in`pyproject.toml` and`src/neuralcache/version.py`. |
| 7 | +2. Update`CHANGELOG.md` (date + entries) and create a`RELEASE_NOTES_<version>.md`. |
| 8 | +3. Commit and tag: |
| 9 | +```bash |
| 10 | + git add. |
| 11 | + git commit -m"release: vX.Y.Z <summary>" |
| 12 | + git tag vX.Y.Z |
| 13 | + git push origin main --follow-tags |
| 14 | +``` |
| 15 | +4. Build artifacts: |
| 16 | +```bash |
| 17 | + python -m pip install --upgrade pip build twine |
| 18 | + python -m build |
| 19 | +``` |
| 20 | +5. Upload: |
| 21 | +```bash |
| 22 | +export TWINE_USERNAME=__token__ |
| 23 | +export TWINE_PASSWORD=$PYPI_API_TOKEN# or set in shell profile |
| 24 | + python -m twine upload dist/neuralcache-X.Y.Z* |
| 25 | +``` |
| 26 | +6. Verify: |
| 27 | +```bash |
| 28 | + pip install --upgrade neuralcache==X.Y.Z |
| 29 | + python -c"import neuralcache, neuralcache.version; print(neuralcache.version.__version__)" |
| 30 | +``` |
| 31 | +7. Draft GitHub release using the release notes. |
| 32 | + |
| 33 | +##Notes |
| 34 | +- Keep coverage gate updates incremental to avoid large unreviewable jumps. |
| 35 | +- Avoid pushing build artifacts; only ship source + wheels via PyPI. |
| 36 | +- For security sensitive dependency bumps, reference advisories in commit messages. |
| 37 | + |
| 38 | +##Contacts |
| 39 | +Open a GitHub issue for questions or emailhello@carnotengine.com. |