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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pr_keepachangelog-1.0.6.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.6.tar.gz
Algorithm Hash digest
SHA256 bcd6e11b0d7e1576b498409fa99a3383c0526ba52b3216fca42feddd56c40216
MD5 f5a92f34b78516eb122ca00a07969b3c
BLAKE2b-256 6f7e0bcb03614fa409c264a68cdf637a312b8b9da05a968c8d492f27c05cdaa9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pr_keepachangelog-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 2f71a3988fd6544ce6ee2e8464dffce0403fd83043ab1c9c27b7b81a760be4e3
MD5 3bd99fe2a42287b5b272c1f84be66b27
BLAKE2b-256 41220c33960e7575c3decd155615f40c192cc8b203e5cbcd478cb115287fb2bb

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