Update the release process docs and the latest version in pyproject.toml

This commit is contained in:
erinhmclark
2025-03-07 17:33:32 +00:00
parent 4c21795d5f
commit 1a2d9de819
3 changed files with 113 additions and 99 deletions

View File

@@ -3,11 +3,25 @@
```{note} This is a work in progress.
```
1. Update the version number in [version.py](src/auto_archiver/version.py)
2. Go to github releases > new release > use `vx.y.z` for matching version notation
1. package is automatically updated in pypi
2. docker image is automatically pushed to dockerhub
1. Update the version number in the project file: [pyproject.toml](../../pyproject.toml) following SemVer:
```toml
[project]
name = "auto-archiver"
version = "0.1.1"
```
Then commit and push the changes.
2. Next add a new git tag with the version number:
```shell
git tag -a v0.1.1
git push origin v0.1.1
```
* The package version is automatically updated in PyPi using the workflow [python-publish.yml](../../.github/workflows/python-publish.yml)
* A Docker image is automatically pushed with the git tag to dockerhub using the workflow [docker-publish.yml](../../.github/workflows/docker-publish.yml)
3. Go to GitHub releases > new release > and select the tag you just created.
manual release to docker hub