Skip to main content

Version numbering and git tagging for project releases

Project description

vernum

Version numbering and git tagging for project releases

To install:

sudo pip3 install vernum

What it does:

  • Maintain a file at the root of a project called simply "version" with the version number, e.g. "5.6.2"
  • Update the release file for major, minor, or patch releases - patch is the default
  • Always create and push a git tag with the version number in it

Requirements:

  • Python 3 (to run the command; your project can be anything)
  • CD to the root of the project before running it
  • Be on the branch that you use for releases (i.e. master)
  • Be fully up-to-date in git (i.e. merged, committed, and pushed)

Then run the command:

  • vernum major to update the major version level, i.e. 5.6.2 -> 6.0.0
  • vernum minor to update the minor version level, i.e. 5.6.2 -> 5.7.0
  • vernum patch to update the patch version level, i.e. 5.6.2 -> 5.6.3

Note that patch is the default so you can just say vernum for a patch release

Reference the version file within your code when it needs to know the version. For example, see setup.py in this project.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vernum-2.2.0.tar.gz (2.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vernum-2.2.0-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file vernum-2.2.0.tar.gz.

File metadata

  • Download URL: vernum-2.2.0.tar.gz
  • Upload date:
  • Size: 2.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7

File hashes

Hashes for vernum-2.2.0.tar.gz
Algorithm Hash digest
SHA256 edb24b65f649f557e0c96bacc409ddb9bde1d4af2e3fb350ce35c62de4b7ae1e
MD5 270f1b56830a2c5933456c7eea63320b
BLAKE2b-256 2bca3ba5b959e645673e003800a6ef82c7a245fa15fa9d0fbe70b75470912a16

See more details on using hashes here.

File details

Details for the file vernum-2.2.0-py3-none-any.whl.

File metadata

  • Download URL: vernum-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 4.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7

File hashes

Hashes for vernum-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a4be971a0f5f944ba235074caa8ec8087d0b4c738fb21b66dfbe541e8224d3ab
MD5 5809deb8effece3c2a02825cbdfaf2b1
BLAKE2b-256 dad6b01efe8508b175257d4254b64b7fc571c16da54256fdb65a156441aa8386

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page