Skip to main content

Conflict-Free Changelog manager

Project description

cf_changelog - Conflict-Free Changelog manager

Simple tool to support changelog modifications on different git branches without conflicts on merging. Written in python, installable with pip.

Usage

  1. Install it from pip:
pip install cf_changelog
  1. Create some changelog on different branches entries using:
cf_changelog add

It is recommended to run this from root of your repository. This will invoke standard text editor (or notepad if standard editor is not configured), where you can fill a template with new features, bug fixes etc. Example:

New:
    - One new cool feature
    - Another cool feature
Bugfix:
    - Fixed bug of previous feature
    - Fixed another bug
  1. Commit newly created files.
  2. Repeat 2 and 3 on different branches as many times as you need.
  3. Merge all branches.
  4. On merged branch run:
cf_changelog release X.Y.Z

where X.Y.Z is description of version you wan't to see in final changelog. 7. Commit registered changes in git repository 8. Enjoy your updated changelog.

Project status

It is very initial version. Manual tests passed. Waiting for some feedback before moving on.

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

cf_changelog-1.0.0.tar.gz (4.5 kB view hashes)

Uploaded Source

Built Distribution

cf_changelog-1.0.0-py3-none-any.whl (5.2 kB view hashes)

Uploaded Python 3

Supported by

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