MAKE_RELEASE.rst

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 ! git log --oneline v3.0.0..HEAD > commit.log git log v3.0.0..HEAD | grep Author > contributors.log

  • 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/

• on local repo

  • update github pages git checkout gh-pages git checkout origin/master -- README.rst
  • Convert README.rst to index.md https://cloudconvert.com/rst-to-md
  • commit and push index.md

• 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)