Skip to main content

A Git versioning plugin for PyBuilder

Project description

PyBuilder Git Version Plugin

Summary

This project is a plugin for PyBuilder that sets the project version based on git tags.

Usage

To use the plugin put the following in the plugins section of build.py:

use_plugin('pybuilder_git_version')

The possible properties for use are:

Property Value Default Usage
use_git_version True / False True Turns off pybuilder_git_version
git_version_commit_distance_as_build_number True / False True Uses commit count from tag as build number

Examples

The following table has examples of repo state and corresponding version number produced.

Tag Branch Clean / Dirty Number of commits since tag Version
0.0.1 master clean 0 0.0.1
0.0.1 master dirty 0 0.0.2+build.0
0.2.2 develop clean 5 0.2.3+develop.5
1.2.3 develop dirty 3 1.2.4+develop.3
1.0.0-rc.1 feature/TICKET-100 clean 5 1.0.0-rc.1+ticket100.5
0.0.1 hotfix/BUG-20 clean 0 0.0.2+bug20.0

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

pybuilder-git-version-0.5.0.tar.gz (3.3 kB view hashes)

Uploaded Source

Built Distribution

pybuilder_git_version-0.5.0-py3-none-any.whl (3.9 kB view hashes)

Uploaded Python 3

Supported by

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