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.0a20.tar.gz (21.2 kB view details)

Uploaded Source

Built Distribution

autopub-1.0.0a20-py3-none-any.whl (23.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: autopub-1.0.0a20.tar.gz
  • Upload date:
  • Size: 21.2 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.0a20.tar.gz
Algorithm Hash digest
SHA256 a52d4b8dc7d1f06282f249c3513557a9463a4168803f408c433490b0ee54306c
MD5 d06575bf1ed77fed26b956ccbe7d5c32
BLAKE2b-256 d7b6f1ff8f2ed985c2f7d8c32594ad1e8c467aec85deb3e565d5ed54aa2d0548

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: autopub-1.0.0a20-py3-none-any.whl
  • Upload date:
  • Size: 23.6 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.0a20-py3-none-any.whl
Algorithm Hash digest
SHA256 e350376d987cdab9857335584b42dc11cfd9d0a4c4624c22019c3dcab7c16fe1
MD5 c1470fc1a8d992c4208a4a3671983ee8
BLAKE2b-256 e1103f238a123526b53f8da051b3c3370a8914b521d1ab4624771e690b2737e0

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