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 can be published via Poetry or setuptools. 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-0.2.1.tar.gz (19.8 kB view details)

Uploaded Source

Built Distribution

autopub-0.2.1-py3-none-any.whl (21.9 kB view details)

Uploaded Python 3

File details

Details for the file autopub-0.2.1.tar.gz.

File metadata

  • Download URL: autopub-0.2.1.tar.gz
  • Upload date:
  • Size: 19.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.7.10 Linux/4.15.0-1102-aws

File hashes

Hashes for autopub-0.2.1.tar.gz
Algorithm Hash digest
SHA256 d4e46edc11c4c6dc3a3f513e4f1c74a79c5a9c5896bb832b7327cdca485a612b
MD5 f23e1aeae230855c576697b8a91a0adb
BLAKE2b-256 eb8029fe7a7cafbcddee9e1c4876b1260d61921d6bd5a9a78db5a36b0ab59698

See more details on using hashes here.

Provenance

File details

Details for the file autopub-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: autopub-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 21.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.7.10 Linux/4.15.0-1102-aws

File hashes

Hashes for autopub-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3260d4ebb369beab40113ace4a212903eeed7740138f18e5bae7aa41e243736a
MD5 a08064e5113597827a1655bd3d89100d
BLAKE2b-256 d8d089f4883069ec8ce5af664ac12e16cafc0b97f171c0e1638ab7c69c8fef6d

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