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
- Install it from pip:
pip install cf_changelog
- Create some changelog on different branches entries using:
cf_changelog add
It is required to run this from root of your repository. This will invoke standard text editor (or notepad/vim if standard editor is not configured), where you can fill a template with new features, bug fixes etc.
Windows example:
This is simple yaml format. You can use as many types of entries as you wish (New, Bugfix, Changed, Fixed, etc.). Each type should contain a flat list. The most important thing is that you don't have to remember anything specific related to this tool, just fill in a template.
- Commit newly created files.
- Repeat 2 and 3 on different branches as many times as you need.
- Merge all branches.
- On merged branch run:
cf_changelog release X.Y.Z
where X.Y.Z is description of version you want to see in final changelog.
- Commit registered changes in git repository (by default: Changelog.md and changelog directory).
- Enjoy your updated changelog.
How it works
addcommand creates files with unique names by default in changelog/sources. Since file names are unique there will be no conflict on merge.releasecommand parses those "source" files and adds them on the begining of Changelog.md. Then copies "source" files to "archive" just to keep them in history. Those commands callsgit addon created and modified files to remind you that you have to commit them.
Project status
- Manual tests on Windows passed
- Manual tests on Ubuntu passed
1 maintainer
Release files for cf-changelog 1.0.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cf_changelog-1.0.6.tar.gz | 4.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cf_changelog-1.0.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size:10.5 kB
Release files / cf_changelog-1.0.6.tar.gz
| Download URL | cf_changelog-1.0.6.tar.gz |
|---|---|
| Size | 4.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
11d2c6b1375732b1e08dc84b204b58c9cd181156fc163b947dfc9154b4b7744c
|
|
BLAKE2b-256 checksum How to use checksums |
16bb1be632adb883957c84aaee39c8f56aaa2016d96608f1a8acac4b7bc38430
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.7.0
|
Release files / cf_changelog-1.0.6-py3-none-any.whl
| Download URL | cf_changelog-1.0.6-py3-none-any.whl |
|---|---|
| Size | 5.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fae96ef6d4bbe0d793b491fd1f642a52fe0e5536a7bf9262f6cc1aa43291c97e
|
|
BLAKE2b-256 checksum How to use checksums |
128c4f076429e0edf4a77f6788952f06fc22d62a0fc6dc63d451439b5049ecb6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.7.0
|
