Maintain

A unified interface to maintaining projects of any language.

Installation

$ pip install maintain

Release Automation

Maintain offers a command to automate bumping version numbers and releasing your project.

$ maintain release patch

This release command will figured out the type of package, whether it be a Python package, Ruby Gem, NPM package etc and then perform the steps necessary to release it. It will bump the version number, create a release commit, tag the release and push it to the respective package manager.

Maintain allows you to specify the major, minor or patch to automatically bump the respective version number, or you can explicitly specify a version.

You may also specify semver as the version to automatically determine the next semantic version. This is not supported on all releasers.

Pull-request

You can configure Maintain to create a pull request and perform the release in two steps. This is useful if you use code-review for the release process:

$ maintain release 1.2.0-beta.1 --pull-request

Once the pull request is merged, you can perform the actual release:

$ maintain release --no-bump

Note

This step could be done during continuous integration.

Custom Hooks

By creating a .maintain.yml file in the root of your repository, you can add hooks to various stages of the release process.

release:
  bump:
    pre:
    - echo 'Hook ran before the version is bumped'
    post:
    - echo 'Hook ran after the version is bumped'
  publish:
    pre:
    - echo 'Hook ran before the library is published'
    post:
    - echo 'Hook ran after the library is published'