hatch-ci 0.1.0

Hatch plugin for ci system versioning

hatch-ci

This provides a plugin to Hatch leveraging a CI/CD system (github at the moment) to deliver packages to PyPi.

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.

• pyproject.toml

  [tool.hatch.version]
  source = "ci"
  

Version source options

• pyproject.toml

  [tool.hatch.version]
  source = "ci"
  
  # this will be updated with __version__ and __hash__ info
  version-file = "src/hatch_ci/__init__.py"
  
  # the files here will be jinja2 processed dynamicaly at build time
  paths = [ "README.md" ]
  
  # the paths will have the strings 'a' & 'b' replaced before
  # jinja2 processing
  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.