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.4.tar.gz (3.0 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.4-py3-none-any.whl (3.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pr_keepachangelog-1.0.4.tar.gz
  • Upload date:
  • Size: 3.0 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.4.tar.gz
Algorithm Hash digest
SHA256 4698a1d7ced19505b7ebe9fa4ca06a38e3702c57c9452815456bce030c6f48d6
MD5 69660cb19433cde41e22bfff5f2e9d38
BLAKE2b-256 7523546a67bfdbbfe635cc61b41e4d6e6464d7f251f59b11622e3511dbf3c413

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pr_keepachangelog-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8b1b713f9cae4d187653b397e5e9aac07ed9cd2eb2779525b3f9cddab71f4225
MD5 dd1e38e48e643312d8c92a38d4213c25
BLAKE2b-256 c00c2c64e7f4f1f4f5c5697d4a05c6d0983dd55ce78d1cb4be45b0c857236c51

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