docs: add steps to publish new version of package

2026-07-24 14:59:05 +02:00
parent 4e94b2a9a3
commit 2f740a0d59
1 changed files with 8 additions and 5 deletions
@@ -2,10 +2,13 @@

 SLS-2 Online Model for beam dynamics

-## Packaging
+## Publish a new version of this package

-```
-uv build
-```
+0. Create changes in the code
+1. Bump the version in `pyproject.toml` -- try to follow `https://semver.org/`
+2. Add a git tag with the version you specified in `pyproject.toml`:
+    - `git tag v<version>`, for example: `git tag v0.3.0`
+3. Push the git tag:
+    - `git push origin tag v<version>`, for example: `git push origin tag v0.3.0` 

-generates `dist/*`
+The actions in `.gitea/workflows/release.yml` will then be triggered and publish the new release to `https://gitea.psi.ch/sls/OM/packages`