Contents Menu Expand Light mode Dark mode Auto light/dark mode
setuptools-git-versioning 1.13.5
setuptools-git-versioning 1.13.5
  • Differences from other tools

How to

  • Install
  • Console command
  • CI configuration
  • Retrieving package version at runtime
  • Versioning schemas
    • Tag-based release (not recommended)
      • Release is a git tag
      • Post release
      • Dirty version
    • File-based release (recommended)
      • Read some file content as current version
      • Development releases (prereleases) from dev branch
      • Development releases from any branch
      • Development releases using only branch name
    • Callback-based release (advanced)
      • Execute some callback function to get current version
  • Config options
    • enabled
    • starting_version
    • template
    • dev_template
    • dirty_template
    • version_file
    • count_commits_from_version_file
    • version_callback
    • sort_by
    • branch_formatter
    • tag_formatter
    • tag_filter
  • Template substitutions
    • tag
    • ccount
    • sha
    • full_sha
    • branch
    • env
    • timestamp
  • Common issues
    • Every version built by CI is dirty
    • Wrong tag ordering/latest tag number detection

Develop

  • Changelog

Project Links

  • Source Code
  • CI/CD
  • Code Coverage
  • Issue Tracker
  v: latest
Versions
latest
stable
v1.13.5
v1.13.4
v1.13.3
1.12.0
v1.11.0
v1.10.1
v1.10.0
1.10.0
v1.9.2
v1.9.1
v1.9.0
v1.8.1
v1.8.0
Downloads
On Read the Docs
Project Home
Builds
Back to top
Edit this page

Callback-based release (advanced)#

  • Execute some callback function to get current version
Next
Execute some callback function to get current version
Previous
Development releases (prereleases) from dev branch
Copyright © 2022, dolfinus
Made with Sphinx and @pradyunsg's Furo