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.11.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.11-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pr_keepachangelog-1.0.11.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.11.tar.gz
Algorithm Hash digest
SHA256 edc2a0ac8bd00971d33522b6d48ec0e0e9a9ddf33bd269d7cafcc0f2649930ec
MD5 67d369ea2eaf13969ab354102ab7ff74
BLAKE2b-256 2c3ebe0f7a794d79d53ef5c88362146252d06c47b51a250416448ca90e91e5a1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pr_keepachangelog-1.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 51c7bdeb7939307730f30f900adf37caed4334046c3d4cd7e7dd876564eb01e0
MD5 27795a033000d858e0b107291c9ebcfd
BLAKE2b-256 62d13fad52f6346e862e3c179b6c6ad297fc5d6291acb24c894c12e170fc0fb7

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