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

Uploaded Source

Built Distribution

autopub-1.0.0a10-py3-none-any.whl (22.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: autopub-1.0.0a10.tar.gz
  • Upload date:
  • Size: 20.0 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.0a10.tar.gz
Algorithm Hash digest
SHA256 57948b2f406519b12547bcdb421d480ce8d20d297f46bc9301115f7b6f6e25c0
MD5 5901efbd7d0cb623c5298faebc39fb81
BLAKE2b-256 4c2d8515459355bfafbf7ecb956db6270a8d7c44c99bf1749074dfb9fbcfd4b2

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: autopub-1.0.0a10-py3-none-any.whl
  • Upload date:
  • Size: 22.2 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.0a10-py3-none-any.whl
Algorithm Hash digest
SHA256 90b31ac2c6a943ee4a8626bea82c7b46c79ae3197ad4031cb2c41e70d7bd1a33
MD5 702084a82a8df8a61d8af3c8fe139892
BLAKE2b-256 bc614f8cb4cac6cc5dc3b1b1be75f5964d52dcf7fa77f72a0efabf11a87b6134

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