File tree Expand file tree Collapse file tree 1 file changed +50
-0
lines changed Expand file tree Collapse file tree 1 file changed +50
-0
lines changed Original file line number Diff line number Diff line change 1+ # Release Steps
2+
3+ ## Quick Release
4+
5+ 1 . Update release notes (` RELEASE_NOTES.md ` )
6+ 2 . Bump version (bumpversion [ patch|minor|major] )
7+ 3 . Push new tag (` git push origin main --tags ` )
8+
9+ ### Bump version (updates files + creates tag)
10+
11+ ``` bash
12+ bumpversion [patch| minor| major]
13+ ```
14+
15+ ### Create and push tag (triggers automated PyPI deployment)
16+
17+ ``` bash
18+ git tag -a vX.Y.Z -m " Version X.Y.Z"
19+ git push origin main --tags
20+ ```
21+
22+ ** Monitor** : https://github.com/terminusdb/terminusdb-client-python/actions
23+
24+ ## Details
25+
26+ ### What bumpversion updates
27+ - ` terminusdb_client/__version__.py `
28+ - ` pyproject.toml `
29+ - ` .bumpversion.cfg `
30+
31+ ### Automated deployment
32+ Pushing a tag triggers GitHub Actions to:
33+ - Run tests (Python 3.8-3.12)
34+ - Build with Poetry
35+ - Publish to PyPI
36+
37+ ### Manual deployment (if needed)
38+ ``` bash
39+ poetry build
40+ poetry publish
41+ ```
42+
43+ ### Troubleshooting
44+
45+ ** Version conflicts:** Never delete published PyPI versions. Create a new patch release instead.
46+
47+ ## Prerequisites
48+
49+ - Install: ` pip install bumpversion `
50+ - PyPI publishing handled via ` PYPI_API_TOKEN ` secret in GitHub Actions
You can’t perform that action at this time.
0 commit comments