Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/src/release_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This document is meant as a guide on how to perform and publish a new release ve

1. Make sure all the tests from the latest [ci-runner workflow](https://github.com/ethstaker/ethstaker-deposit-cli/actions/workflows/runner.yml) on the latest commit of the main branch are completed. Make sure all tests are passing on all the supported platforms.
2. Determine a new version number. Version numbers should adhere to [Semantic Versioning](https://semver.org/). For any official release, it should include a major, a minor and a patch identifier like `1.0.0`.
3. Update `ethstaker_deposit/__init__.py`'s `__version__` variable with the new version number. Commit this change to the main branch of the main repository.
3. Update `ethstaker_deposit/VERSION`'s content with the new version number. Commit this change to the main branch of the main repository.
4. Add a tag to the main repository for this changed version commit above. The name of this tag should be a string starting with `v` concatenated with the version number. With git, the main repository cloned and the commit above being the head, it can look like this:
```console
git tag -a -m 'Version 1.0.0' v1.0.0
Expand All @@ -15,7 +15,7 @@ git push origin v1.0.0
7. If this is not a production release, check the *Set as a pre-release* checkbox.
8. Click the *Publish release* button.
9. Determine a new dev version number. You can try to guess the next version number to the best of your ability. This will always be subject to change. Add a `dev` identifier to the version number to clearly indicate this is a dev version number.
10. Update `ethstaker_deposit/__init__.py`'s `__version__` variable with a new dev version number. Commit this change to the main branch.
10. Update `ethstaker_deposit/VERSION`'s content with a new dev version number. Commit this change to the main branch.

## Release Notes Template

Expand Down
1 change: 1 addition & 0 deletions ethstaker_deposit/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1.2.2
4 changes: 4 additions & 0 deletions ethstaker_deposit/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from importlib.resources import files

__version__ = files(__package__).joinpath("VERSION").read_text().strip()
__all__ = ["__version__"]
2 changes: 1 addition & 1 deletion ethstaker_deposit/settings.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from typing import Dict, NamedTuple, Optional
from eth_utils import decode_hex

from ethstaker_deposit.version import __version__
from ethstaker_deposit import __version__

DEPOSIT_CLI_VERSION = __version__

Expand Down
1 change: 0 additions & 1 deletion ethstaker_deposit/version.py

This file was deleted.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
where = ["."]

[tool.setuptools.dynamic]
version = {attr = "ethstaker_deposit.version.__version__"}
version = { file = "ethstaker_deposit/VERSION" }

[tool.pip-tools]
generate-hashes = true
Expand Down