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

Uploaded Source

Built Distribution

autopub-1.0.0a19-py3-none-any.whl (23.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: autopub-1.0.0a19.tar.gz
  • Upload date:
  • Size: 21.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.0a19.tar.gz
Algorithm Hash digest
SHA256 f9007a98f895a4de362f0e9156b548f065c60ee379814d90f3e2649bb8957ada
MD5 e48b53b7d9cc013bc848fea1c172d1ef
BLAKE2b-256 419660341e6b2b19fb50a54a81e199cda2f4ae3ddb97016a6bf2e03d8209f8d9

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: autopub-1.0.0a19-py3-none-any.whl
  • Upload date:
  • Size: 23.4 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.0a19-py3-none-any.whl
Algorithm Hash digest
SHA256 e998ae751cf4f37f59a59a498b1d0e989f10ce23bb5252d7bc957bf76fbd0b38
MD5 adc503bf52462d24a866972d4457a6a8
BLAKE2b-256 752dc9187f90e2813c682a82c82b63e0cbbce147178d89a211c7e96169e59f7b

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