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.1.3.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.1.3-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vernum-2.1.3.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.6

File hashes

Hashes for vernum-2.1.3.tar.gz
Algorithm Hash digest
SHA256 ff16337fc6c9210958970b1cba392f9b031bec834c42c704486a57f2dad77f9f
MD5 a8918415a176f613f9d336c904d70a2a
BLAKE2b-256 e185aac4ed4d38634f8ec4f43629a58a7deb7356b08b29d7290b0755b07a965a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vernum-2.1.3-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.6

File hashes

Hashes for vernum-2.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 67902b594590ab6353c97f7660a07f570fadea0354695cc17aab21d3ef222dc2
MD5 3842d1fad3fd960618e3e017af6769bb
BLAKE2b-256 167d9c311bf9fd9b3fc66bd8cc3c9357a14c5534d8e0c0bb9ed463656a927486

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