Skip to main content

Safely creating releases when you change the version number.

Project description

CircleCI

Carthorse

Safely creating releases when you change the version number.

You use it by adding configuration to a yaml or toml file, and then adding the following to your continuous integration pipeline:

pip install -U carthorse
carthorse

TOML Configuration

Your file should contain a section such as the following:

[tool.carthorse]
version-from = "poetry"
tag-format = "v{version}"
when = [
  "version-not-tagged"
]
actions = [
   { run="poetry publish --username $POETRY_USER --password $POETRY_PASS --build"},
   { name="create-tag"},
]

This is designed so that it can be included as part of a pyproject.toml file.

YAML Configuration

Your file should contain a section such as the following:

carthorse:
  version-from: poetry
  tag-format: v{version}
  when:
    - version-not-tagged
  actions:
    - run: "poetry publish --username $POETRY_USER --password $POETRY_PASS --build"
    - create-tag

What does it do?

Roughly speaking:

  • Extract your project’s version from its source code.
  • Format a tag based on the version
  • Perform a number of checks, if any of those fail, stop.
  • Perform any actions you specify.

Version extraction

The following methods of extracting the version of a project are currently supported:

setup.py
This will run python setup.py --version and use the version returned.
poetry
This will parse a project’s pyproject.toml and use the tool.poetry.version key as the version for the project.
flit

This will extract the version from a flit-style __version__ without importing the package. For example, if your module is called foobar, this will look in either foobar/__init__.py or foobar.py. The config for that would be:

[tool.carthorse]
version-from = { name="flit", module="foobar" }

path

This will extract the version from a specified file. By default, this will be the stripped contents of the whole file, but a pattern can be specified. This can be useful to extract the version from a setup.py without executing it. The config would that would be:

[tool.carthorse]
version-from = { name="path", path="setup.py", pattern="version='(?P<version>[^']+)" }

Tag formatting

The tag-format configuration option lets you control the format of the version tag by specifying a python format string into which the version will be interpolated. The default is v{version}.

Performing checks

Each check in the when configuration section will be performed in order. If any fail then no actions will be performed.

The following checks are currently available:

version_not_tagged
This will pass if no current git tag exists for the version extracted from the poject.
never
A safety net and testing helper, this check will never pass.

Actions

If all the checks pass, then the actions listed are executed in order. If an error occurs during the execution of an action, no further actions will be executed.

The following actions are currently available:

run
Run the specified command in a shell. The full environment will be passed through and $TAG will contain the tag computed from the tag format.
create_tag
This will create a git tag for the computed tag based on the extracted version and push it to the specified remote. By default, the origin remote is used.

Changes

1.2.0 (12 Sep 2020)

  • Support extracting the project version from flit-style project.
  • Support extracting the project version from a file, or part of a file by regex.

1.1.0 (1 Mar 2019)

  • Support extracting the project version from a setup.py.
  • Support for other packages providing version-from, when and actions callables.

1.0.1 (27 Feb 2019)

  • Better PyPI metadata.

1.0.0 (27 Feb 2019)

  • First release, supporting poetry and git tagging.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for carthorse, version 1.2.0
Filename, size File type Python version Upload date Hashes
Filename, size carthorse-1.2.0-py3-none-any.whl (6.3 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size carthorse-1.2.0.tar.gz (5.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page