Skip to main content

Easy semantic versioning for projects in Git

Project description

VERNUM

Version numbering and git tagging for project releases

Installation

Requires Python 3 to run the command; your project can be anything.

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

Usage

Requirements:

  • 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-3.0.0.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

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

vernum-3.0.0-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vernum-3.0.0.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for vernum-3.0.0.tar.gz
Algorithm Hash digest
SHA256 6e1dc8a9bdb1278f8bc74750fa5f9b76f4bc4aedff237f118a8cc9d8f385385d
MD5 2148bff8215f0b53a8e07f803e3b004b
BLAKE2b-256 e35c5c70d631c03dc1a896b02b00339e54f423903c9429c7a5a64138a10bd0ca

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vernum-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 4.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for vernum-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 33288981a9559d1a3273fb91de74727d0fde02477a97fbba4c45dc9a7e787f32
MD5 aada22df3631afd7dd0e52d5e62048c0
BLAKE2b-256 3db84006453e668a1f1f7d3906e5574c9cba197c863ab05a1cb06f207e40f541

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