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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

pr_keepachangelog-1.0.7-py3.10.egg (15.4 kB view details)

Uploaded Egg

File details

Details for the file pr_keepachangelog-1.0.7-py3.10.egg.

File metadata

  • Download URL: pr_keepachangelog-1.0.7-py3.10.egg
  • Upload date:
  • Size: 15.4 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for pr_keepachangelog-1.0.7-py3.10.egg
Algorithm Hash digest
SHA256 a69a25f213ac2e55271746713d6e65cf1cb736c38e070c4b32de575f7856b7f0
MD5 97a2ebc87fec1ab85df64b5305cecc1a
BLAKE2b-256 219d7dd0cba6e6dda94146ff74de9834323c9e19ed84d9cd0edf90b891cb7b41

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