Automatic package release upon pull request merge
Project description
AutoPub
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: Runprepare,build,commit,githubrelease, andpublishin one invocation.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file autopub-1.0.0a1.tar.gz.
File metadata
- Download URL: autopub-1.0.0a1.tar.gz
- Upload date:
- Size: 19.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.11.0 Darwin/23.1.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | be85ed9a59ce4966b9571e46406d05a026e9d1616dd2f90c6d4bddd97efdb712 |
|
| MD5 | f558cbdeeed7fbc357e3330e4454732c |
|
| BLAKE2b-256 | d523a03fad40e0d1252641b8660c11154484910a12f1b796d998a9c8c3737b85 |
Provenance
File details
Details for the file autopub-1.0.0a1-py3-none-any.whl.
File metadata
- Download URL: autopub-1.0.0a1-py3-none-any.whl
- Upload date:
- Size: 21.5 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4c74a705597f78800862c8ad3469e98d15793f21c8391b3f6e2b77e630217412 |
|
| MD5 | a51b89c4c97dd9ecad3f8937c3bfe46f |
|
| BLAKE2b-256 | 885d8791902c53cbf424598b6172d6ad5448fb0eadb8b81cf41bc55e6504a635 |
