Signed-off-by: Daniel Baumann <daniel@debian.org>

2025-02-10 06:39:52 +01:00

Notes

Notes regarding how to release eos-downloader package

Package requirements

Also, Github CLI can be helpful and is recommended

In a branch specific for this, use the bumpver tool. It is configured to update:

For instance to bump a patch version:

bumpver update --patch --tag final

and for a minor version

bumpver update --minor --tag final

Tip: It is possible to check what the changes would be using --dry

bumpver update --minor  --tag final --dry

For a development version, you can use the following:

bumpver update --minor  --tag dev --tagnum --dry

The following tag should be used:

![INFORMATION] This tags are not released to pypi and are only available via git installation.

Create the release on Github with the appropriate tag vx.x.x

Important

TODO - make this a github workflow

x.x.x is the version to be released

This is to be executed at the top of the repo

Checkout the latest version of main with the correct tag for the release
Create a new branch for release
```
git switch -c rel/vx.x.x
```
[Optional] Clean dist if required
Build the package locally
```
python -m build
```
Check the package with twine (replace with your vesion)
```
twine check dist/*
```

Upload the package to test.pypi

twine upload -r testpypi dist/eos-downloader-x.x.x.*

Verify the package by installing it in a local venv and checking it installs and run correctly (run the tests)

# In a brand new venv
pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple --no-cache eos-downloader

Push to eos-downloader repository and create a Pull Request

git push origin HEAD
gh pr create --title 'bump: eos-downloader vx.x.x'

gh pr merge --squash

Like 7 but for normal pypi

# In a brand new venv
pip install eos-downloader