hatch-ci 0.1.2b38

Hatch plugin for ci system versioning

hatch-ci

This is a hatch-vcs heavily inspired pluging, managing the version information for a python wheel package.

It gets version information from:

• version-file entry in the tool.hatch.version toml entry (eg. 1.0.0) in the master branch
• augments it with a bNNN build number in creating the package foobar-1.0.0bNNNN (this can be sent to PyPi)
• if there's a tag v1.0.0 on the repo, it will build foobar-1.0.0 release (this can be sent to PyPi)

The last two steps are mean to be managed in a CI/CD system (github at the moment), to ensure hands-off releases.

In essence this pluging:

• manages the version information
• allows version replacement in text files using build information

NOTE: this is heavily inspired from hatch-vcs

Table of Contents

• Global dependency
• Version source
  • Version source options
• License

Global dependency

Ensure hatch-ci is defined within the build-system.requires field in your pyproject.toml file.

[build-system]
requires = ["hatchling", "hatch-ci"]
build-backend = "hatchling.build"

Version source

The version source plugin name is ci.

This will enable the hatch-ci pluging:

• pyproject.toml

  [project]
  ..
  dynamic = ["version"]  # this rerieves the version dynamically
  ..
  

Version source options

• pyproject.toml

  [tool.hatch.version]
  source = "ci"  # this pulls the version using the hatch-ci hook
  
  # this will put/update __version__ and __hash__ info in version-file
  version-file = "src/hatch_ci/__init__.py"
  
  # these files will be jinja2 processed, the environment will
  # contains variables as: branch, build, current, ref, runid, 
  # sha, version, workflow etc.
  paths = [ "README.md" ]
  
  # the listed paths will undergo replacement before jinja2 processing and
  # the strings 'a' & 'b' wil be replaced
  fixers = [
      { 'a': '{ctx.workflows}' },
      { 'd': '{ctx.branch}' }
  ]
  

Option	Type	Default	Description
version-file	str	None	A file where to write version/hash variables
paths	`list[str]	str`	None
fixers	list[dict[str,str]]	None	A list of dict, each key is a string to replace with the value

License

hatch-ci is distributed under the terms of the MIT license.