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 are built via build and published via Twine. 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-1.0.0a4.tar.gz (19.8 kB view details)

Uploaded Source

Built Distribution

autopub-1.0.0a4-py3-none-any.whl (21.7 kB view details)

Uploaded Python 3

File details

Details for the file autopub-1.0.0a4.tar.gz.

File metadata

  • Download URL: autopub-1.0.0a4.tar.gz
  • Upload date:
  • Size: 19.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.0 Darwin/23.1.0

File hashes

Hashes for autopub-1.0.0a4.tar.gz
Algorithm Hash digest
SHA256 11549ec40be9b4e83e8aaf6566ba03dde68f152d9348e965e48427458cf3f34b
MD5 16aa3f0edcab883c3e598061d9344e55
BLAKE2b-256 6ba8f22123ea06dfcc607ae19910a557efddbda5eb7fd1acafcbf37650308780

See more details on using hashes here.

Provenance

File details

Details for the file autopub-1.0.0a4-py3-none-any.whl.

File metadata

  • Download URL: autopub-1.0.0a4-py3-none-any.whl
  • Upload date:
  • Size: 21.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.0 Darwin/23.1.0

File hashes

Hashes for autopub-1.0.0a4-py3-none-any.whl
Algorithm Hash digest
SHA256 14e97f36008582c81703a00ba95174bd0d757a6877399b1de9cc79214d388fe0
MD5 2ce26529c332a07c9ac80369dfabf4a4
BLAKE2b-256 83f16d7478589f8e0c14e6d3f559d108fcf56fcaacb80c917ddc613370b4d0bd

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