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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for vernum-3.1.1.tar.gz
Algorithm Hash digest
SHA256 d294f576103cf1bd129df2afd1db013fda7faa97f29003b8ac4c7ee4f72415a0
MD5 762cf6b9146aeea80b20c08d0e0857a2
BLAKE2b-256 204ddc80282a7010e1374f7172eda1acaa7998d093ad3a6c819cdc3cd78bcdda

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for vernum-3.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 964671b64ff843c1aef75aa4de3a6dbac7b4397affe4b59e2b1ab652000fd4cd
MD5 9b94036dd4af58b9bf029e216a5038a7
BLAKE2b-256 a62cd5651c61d0f2d1a0c446f9f8e769b8bc21a6e37d33903077722a180f8fd7

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