Skip to content

Commit

Permalink
gguf : add workflow for Pypi publishing (#2896)
Browse files Browse the repository at this point in the history
* gguf : add workflow for Pypi publishing

* gguf : add workflow for Pypi publishing

* fix trailing whitespace
  • Loading branch information
monatis authored Aug 30, 2023
1 parent 9509294 commit 0d1c706
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 3 deletions.
43 changes: 43 additions & 0 deletions .github/workflows/gguf-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# This workflow will upload a Python Package using Twine when a GGUF release is created
# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries

# See `gguf-py/README.md` for how to make a release.

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

name: Upload Python Package

on:
workflow_dispatch:
push:
# Pattern matched against refs/tags
tags:
- 'gguf-v*' # Push events to every version tag


jobs:
deploy:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.9.x'
- name: Install dependencies
run: |
cd gguf-py
python -m pip install poetry
poetry install
- name: Build package
run: poetry build
- name: Publish package
uses: pypa/gh-action-pypi-publish@release/v1
with:
password: ${{ secrets.PYPI_API_TOKEN }}
23 changes: 20 additions & 3 deletions gguf-py/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,33 @@ 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
```

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
Expand Down

0 comments on commit 0d1c706

Please sign in to comment.