Skip to content

Commit

Permalink
Added version bumping & release dev docs (#793)
Browse files Browse the repository at this point in the history
* bump cfg

* fix cfg

* norm

* commit and tag

* added release to dev deps and added dev docs
  • Loading branch information
Helveg committed Jan 5, 2024
1 parent 730ea2e commit e452b46
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 4 deletions.
34 changes: 34 additions & 0 deletions .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
[bumpversion]
current_version = 4.0.0.b2
files = bsb/__init__.py
commit = True
tag = True
parse = ^
(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)
(\.(?P<prekind>a|alpha|b|beta|d|dev|rc)
(?P<pre>\d+) # pre-release version num
)?
(\.(?P<postkind>post)(?P<post>\d+))? # post-release
serialize =
{major}.{minor}.{patch}.{prekind}{pre}.{postkind}{post}
{major}.{minor}.{patch}.{prekind}{pre}
{major}.{minor}.{patch}.{postkind}{post}
{major}.{minor}.{patch}

[bumpversion:part:prekind]
optional_value = _
values =
_
dev
d
alpha
a
beta
b
rc

[bumpversion:part:postkind]
optional_value = _
values =
_
post
2 changes: 1 addition & 1 deletion bsb/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
install the `bsb` package instead.
"""

__version__ = "4.0.0b2"
__version__ = "4.0.0.b2"

import functools

Expand Down
13 changes: 11 additions & 2 deletions docs/dev/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,21 @@ Developer Installation

To install::

git clone git@github.com:dbbs-lab/bsb
cd bsb
git clone git@github.com:dbbs-lab/bsb-core
cd bsb-core
pip install -e .[dev]
pre-commit install


Test your install with::

python -m unittest discover -s tests

Releases
--------

To release a new version::

bump2version pre
python -m build
twine upload dist/* --skip-existing
5 changes: 4 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,13 @@ docs = [
"sphinxext-bsb~=0.2.1"
]
dev = [
"build~=1.0",
"twine~=4.0",
"pre-commit~=3.5",
"black~=23.11",
"isort~=5.12",
"snakeviz~=2.1"
"snakeviz~=2.1",
"bump2version~=1.0"
]

[tool.black]
Expand Down

0 comments on commit e452b46

Please sign in to comment.