Skip to main content

Automatic package release upon pull request merge

Project description

AutoPub

Build Status PyPI Version

AutoPub enables project maintainers to release new package versions to PyPI by merging pull requests.

Environment

AutoPub is intended for use with continuous integration (CI) systems such as GitHub Actions, CircleCI, or Travis CI. Projects used with AutoPub can be published via Poetry or setuptools. Contributions that add support for other CI and build systems are welcome.

Configuration

AutoPub settings can be configured via the [tool.autopub] table in the target project’s pyproject.toml file. Required settings include Git username and email address:

[tool.autopub]
git-username = "Your Name"
git-email = "your_email@example.com"

Release Files

Contributors should include a RELEASE.md file in their pull requests with two bits of information:

  • Release type: major, minor, or patch
  • Description of the changes, to be used as the changelog entry

Example:

Release type: patch

Add function to update version strings in multiple files.

Usage

The following autopub sub-commands can be used as steps in your CI flows:

  • autopub check: Check whether release file exists.
  • autopub prepare: Update version strings and add entry to changelog.
  • autopub build: Build the project.
  • autopub commit: Add, commit, and push incremented version and changelog changes.
  • autopub githubrelease: Create a new release on GitHub.
  • autopub publish: Publish a new release.

For systems such as Travis CI in which only one deployment step is permitted, there is a single command that runs the above steps in sequence:

  • autopub deploy: Run prepare, build, commit, githubrelease, and publish in one invocation.

Project details


Download files

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

Source Distribution

autopub-0.1.4.tar.gz (19.0 kB view details)

Uploaded Source

Built Distribution

autopub-0.1.4-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

Details for the file autopub-0.1.4.tar.gz.

File metadata

  • Download URL: autopub-0.1.4.tar.gz
  • Upload date:
  • Size: 19.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.3 CPython/3.7.3 Darwin/17.7.0

File hashes

Hashes for autopub-0.1.4.tar.gz
Algorithm Hash digest
SHA256 82d97e398e84340f746f348871af500504711711f9f1ebf4b5929f3eaf2aeb31
MD5 498cc5ac2eea0b2d56657a7bc7399eb6
BLAKE2b-256 e7fcc0fcf6829b3a617dea970bdeab56b9d45eb145ceb66d1c0a7c6679b977f9

See more details on using hashes here.

Provenance

File details

Details for the file autopub-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: autopub-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 20.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.3 CPython/3.7.3 Darwin/17.7.0

File hashes

Hashes for autopub-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4bdc13d2e8085c909051d5ea77bbee8dc11dadff7a651df80fab9a74ca8d15b4
MD5 693ada571abba1f85f97ee42e725f605
BLAKE2b-256 2b0dcb269d48dda6f1dd4cd8f0d92f37f9a922a61883c096bcb2d520a522f3e7

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page