Skip to main content

Add pull requests to changelog automatically with BitBucket pipelines and release changelog with keepachangelog.

Project description

Documentation

The package can be installed with pip install pr-keepachangelog. For help and to use it: python -m pr_keepachangelog.

Based on a pull request that is merged on a certain branch, you can populate the changelog automatically. The category in which the changelog is populated depends on the prefix of the specified branch:

  • hotfix/ -> Fixed
  • feature/ -> Fixed
  • bugfix/ -> Fixed

additional branch types

  • deprecated/ -> Deprecated
  • changed/ -> Changed
  • removed/ -> Removed
  • security/ -> Security

Keepachangelog categories

Keepachangelog will guess the new version number when you make a release with --release:

  • Added: for new features. Results in minor update.
  • Changed: for changes in existing functionality. Results in major update.
  • Deprecated: for soon-to-be removed features. Results in major update.
  • Removed: for now removed features. Results in major update.
  • Fixed: for any bug fixes (hotfix/bugfix). Results in patch update.
  • Security: in case of vulnerabilities. Results in patch update.

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

pr_keepachangelog-1.0.10.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pr_keepachangelog-1.0.10-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file pr_keepachangelog-1.0.10.tar.gz.

File metadata

  • Download URL: pr_keepachangelog-1.0.10.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for pr_keepachangelog-1.0.10.tar.gz
Algorithm Hash digest
SHA256 568729106939fc21da96f947cdf65bfc7e2aa302a2b17a2fc5d1db444bae3f0c
MD5 4e6aceb863b8ee8e0aa8fb080723d14e
BLAKE2b-256 59270902f4b71ced55b444cb8d33330bb928c0bcfe406c7b7295975fbe030168

See more details on using hashes here.

File details

Details for the file pr_keepachangelog-1.0.10-py3-none-any.whl.

File metadata

File hashes

Hashes for pr_keepachangelog-1.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 1d147c97ce44987187fb3539db6fc1061d1b008d00336a0706fba474b864702c
MD5 7f9608bc39135b66a4a0d84556b7bc46
BLAKE2b-256 d9ba76103402a01b482be33a6a30a557e08ffbf167e1d2d80756fa2fe7f831f9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page