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
40 changes: 40 additions & 0 deletions MAKE_RELEASE.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
================================
PyModbus - A Python Modbus Stack
================================
=================
Making a release.
=================

------------------------------------------------------------
Prepare/make release on dev.
------------------------------------------------------------
* Make pull request "prepare v3.0.x", with the following:
* Update pymodbus/version.py with version number (last line)
* Update README.rst "Supported versions"
* Update CHANGELOG.rst
* Add commits from last release, but selectively !
* Commit, push and merge.
* Checkout master locally
* git merge dev
* git push
* wait for CI to complete on all branches
* On github "prepare release"
* Create tag e.g. v3.0.1dev0
* Title "pymodbus v3.0.1dev0"
* do NOT generate release notes, but copy from CHANGELOG.rst
* make release (remember to mark pre-release if so)
* on local repo
* git pull, check release tag is pulled
* git checkout v3.0.0dev0
* python3 setup.py sdist bdist_wheel --universal
* twine upload dist/* (upload to pypi)
* Double check Read me docs are updated
* trigger build https://readthedocs.org/projects/pymodbus/builds/
* Make an announcement in discussions.


------------------------------------------------------------
Prepare release on dev for new commits.
------------------------------------------------------------
* Make pull request "prepare dev", with the following:
* Update pymodbus/version.py with version number (last line)
3 changes: 1 addition & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Supported versions

Version `2.5.3 <https://github.com/riptideio/pymodbus/releases/tag/v2.5.3>`_ is the last 2.x release (Supports python 2.7.x - 3.7).

Version `3.0.0 <https://github.com/riptideio/pymodbus/releases/tag/v3.0.0>`_ is the latest release of 3.0.0 (Supports Python >=3.8).
Version `3.0.0 <https://github.com/riptideio/pymodbus/releases/tag/v3.0.0>`_ is the current release (Supports Python >=3.8).

Remark: "Supports" means that we only test with those versions, lower versions (e.g. 3.7) might work depending on the functionality used.

Expand Down Expand Up @@ -248,7 +248,6 @@ we accept devices via mail or by IP address.
That said, the current work mainly involves polishing the library and
solving issues:

* Get version 3.0.0 released
* Fixing bugs/feature requests
* Architecture documentation
* Functional testing against any reference we can find
Expand Down
2 changes: 1 addition & 1 deletion pymodbus/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def __str__(self):
return f"[{self.package}, version {self.short()}]"


version = Version("pymodbus", 3, 0, 0, "rc1")
version = Version("pymodbus", 3, 0, 1, "dev0")
version.__name__ = ( # fix epydoc error # pylint: disable=attribute-defined-outside-init
"pymodbus"
)
Expand Down