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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: autopub-1.0.0a8.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.0a8.tar.gz
Algorithm Hash digest
SHA256 df95911a3ffba8dbc1e2f9a71b39838582e73982d7835876c1c2ffc076b827f8
MD5 f5b45c01f99f7e677669cbb81ed90f37
BLAKE2b-256 fac32d1877b1fcec21de8d7369dd4053a152fa3fc3565f1fc42ce8828bf3fed9

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: autopub-1.0.0a8-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.0a8-py3-none-any.whl
Algorithm Hash digest
SHA256 e274c5d86136783fc20abf8cbbe568e64d09b9c772656687fed9d2631a0ba186
MD5 daff13ad87ad863da6a28136ccea22ac
BLAKE2b-256 618243975f5c9c11f8ab2e5cc0af20e6fd462dba286ce240e019e9fc8eb942da

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