You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Rather than spending time updating the 2 files that have hardcoded
versions in them. Let poetry auto-generate the versions directly from
Git tags.
If a dev has a git tag checked out then `poetry build` will generate
a version directly from that tag, for example the tag "v0.15.1" will
produce a version "0.15.1".
Otherwise the version will be based on how many commits since the last
tag was available in Git history for example "0.15.1-post.13+d211ed4347"
where "post.13" represents 13 commits since v0.15.1 was tagged and
"d211ed4347" is the commit hash of the commit that generated this
version.
For this to work however devs are required to install
poetry-dynamic-versioning in addition to poetry at the global level.
Ref: https://pypi.org/project/poetry-dynamic-versioning/
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Copy file name to clipboardExpand all lines: docs/developer/devstart.md
+2
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,8 @@ Setting up the development environment for Suzieq involves the following steps:
7
7
* Make sure you have a python3 version that is > 3.7.1 and less than 3.9.0. If you don't have a system provided python version that matches this requirement, you can use [pyenv](https://realpython.com/intro-to-pyenv/) to install one.
8
8
* If you've used pyenv to install a specific python version, ensure you activate it.
9
9
* Install poetry--follow the instructions posted [here](https://python-poetry.org/docs/#installation).
10
+
* Install *poetry-dynamic-versioning* -- follow the instructions posted
* Ensure you have git installed (follow the instructions [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git))
11
13
* Clone the github repository: ```git clone https://github.com/netenglabs/suzieq.git```. This creates a copy of the code repository in the subfolder suzieq in the current directory.
12
14
* Create the virtual environment and install the appropriate packages by typing: ```poetry install```
0 commit comments