Commit c298f9ff authored by one's avatar one
Browse files

[hytop] Update readme

parent 2ecc1d16
.PHONY: help setup format lint test clean bump build publish .PHONY: help setup format lint test clean bump build
help: help:
@echo "Available targets:" @echo "Available targets:"
...@@ -9,7 +9,6 @@ help: ...@@ -9,7 +9,6 @@ help:
@echo " make clean - Remove build caches and the virtual environment" @echo " make clean - Remove build caches and the virtual environment"
@echo " make bump part=X - Bump version (patch/minor/major or set X.Y.Z)" @echo " make bump part=X - Bump version (patch/minor/major or set X.Y.Z)"
@echo " make build - Build wheel and sdist into dist/" @echo " make build - Build wheel and sdist into dist/"
@echo " make publish - Upload dist/ to PyPI (requires UV_PUBLISH_TOKEN)"
setup: setup:
@echo ">> Initializing virtual environment and installing dependencies..." @echo ">> Initializing virtual environment and installing dependencies..."
...@@ -38,6 +37,3 @@ bump: ...@@ -38,6 +37,3 @@ bump:
build: build:
uv build uv build
publish:
uv publish
...@@ -134,3 +134,23 @@ make bump part=minor # 0.1.1 -> 0.2.0 ...@@ -134,3 +134,23 @@ make bump part=minor # 0.1.1 -> 0.2.0
make bump part=major # 0.2.0 -> 1.0.0 make bump part=major # 0.2.0 -> 1.0.0
make bump part="set 1.2.3" # set an explicit version make bump part="set 1.2.3" # set an explicit version
``` ```
### Publish
Releases are automatically published to PyPI when pushing a version tag:
```bash
# Bump version and commit
make bump part=patch
git commit -am "Bump version to 0.1.1"
# Tag and push to trigger GitHub Actions release
git tag hytop-0.1.1
git push origin hytop-0.1.1
```
To test building distributions locally:
```bash
make build
```
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment