summaryrefslogtreecommitdiff
path: root/gguf-py
diff options
context:
space:
mode:
authorM. Yusuf Sarıgöz <yusufsarigoz@gmail.com>2023-08-30 12:47:40 +0300
committerGitHub <noreply@github.com>2023-08-30 12:47:40 +0300
commit0d1c706181cd31e7f368dd14eeb16c1a2569e4df (patch)
tree15d82459dab9df50ed0c855fd2a92ecb94e0043d /gguf-py
parent950929442070874d45561d2a4b68b010457767de (diff)
gguf : add workflow for Pypi publishing (#2896)
* gguf : add workflow for Pypi publishing * gguf : add workflow for Pypi publishing * fix trailing whitespace
Diffstat (limited to 'gguf-py')
-rw-r--r--gguf-py/README.md23
1 files changed, 20 insertions, 3 deletions
diff --git a/gguf-py/README.md b/gguf-py/README.md
index 03ad306e..ffe25c49 100644
--- a/gguf-py/README.md
+++ b/gguf-py/README.md
@@ -27,8 +27,25 @@ In this case, upgrade Pip to the latest:
pip install --upgrade pip
```
-## Publishing
-To publish the package, you need to have `twine` and `build` installed:
+## Automatic publishing with CI
+
+There's a GitHub workflow to make a release automatically upon creation of tags in a specified format.
+
+1. Bump the version in `pyproject.toml`.
+2. Create a tag named `gguf-vx.x.x` where `x.x.x` is the semantic version number.
+
+```sh
+git tag -a gguf-v1.0.0 -m "Version 1.0 release"
+```
+
+3. Push the tags.
+
+```sh
+git push origin --tags
+```
+
+## Manual publishing
+If you want to publish the package manually for any reason, you need to have `twine` and `build` installed:
```sh
pip install build twine
@@ -36,7 +53,7 @@ pip install build twine
Then, folow these steps to release a new version:
-1. Update the version in `pyproject.toml`.
+1. Bump the version in `pyproject.toml`.
2. Build the package:
```sh