Generate changelogs from a directory structure to avoid merge conflicts
Project description
changelogdir
============
Generate changelogs from a directory structure to avoid merge conflicts.
- Free software: GPLv3+
- Documentation: https://carmenbianca.gitlab.io/changelogdir
- Source code: https://gitlab.com/carmenbianca/changelogdir
- PyPI: https://pypi.python.org/pypi/changelogdir
- Python: 3.4+
- Author: Carmen Bianca Bakker <carmen@carmenbianca.eu>
changelogdir is a simple utility that allows you to turn directory structures
into changelog files. Every feature/bugfix/whatever gets its own file to list
changes in, thereby avoiding merge conflict crises such as described
`here <https://gitlab.com/gitlab-org/gitlab-ce/issues/17826>`_.
changelogdir is partially inspired by
`Keep a Changelog <http://keepachangelog.com>`_.
A simple example
----------------
Say we have a ``CHANGELOG.md`` in our master branch that looks like this::
# Changelog
## 1.0.0
- Added support for TempleOS.
And Developer A comes along and does the following in their branch::
# Changelog
## 1.0.0
- Added support for TempleOS.
- Deprecated support for Windows.
And Developer B has this in their branch::
# Changelog
## 1.0.0
- Added support for TempleOS.
- Added support for Android.
Then merging the two branches into master causes a merge conflict, and it's just
a needless headache.
changelogdir fixes this by putting those entries into individual files. Thus,
you'd end up with something looking like this::
awesome-project
├── CHANGELOG
│ └── 1.0.0
│ ├── android.md
│ ├── templeos.md
│ └── windows.md
└── .changelogdirrc
``.changelogdirrc`` contains::
[changelogdir]
directory = CHANGELOG
file_extension = md
header = # Changelog
section_header = ## {section_name}
``android.md`` contains::
- Added support for Android.
``templeos.md`` contains::
- Added support for TempleOS.
``windows.md`` contains::
- Deprecated support for Windows.
And when running ``changelogdir``, the following is generated in alphabetical
order of the file names::
~/awesome-project$ changelogdir
# Changelog
## 1.0.0
- Added support for Android.
- Added support for TempleOS.
- Deprecated support for Windows.
Of course, it might make more sense to put those three changes into a single
file called ``platform-changes.md``, but this is merely for demonstration.
Installation
------------
See :doc:`Installation <INSTALLATION>`.
Usage
-----
See :doc:`Usage <USAGE>`.
Why doesn't changelogdir have its changelog in the Python package?
------------------------------------------------------------------
Doing this would require having changelogdir installed to be able to build
itself. There is probably a way around this (just call changelogdir.py
directly), but it'd be really ugly.
As a compromise, it does generate its own changelog when creating and uploading
the docs. See https://carmenbianca.gitlab.io/changelogdir/CHANGELOG.html.
============
Generate changelogs from a directory structure to avoid merge conflicts.
- Free software: GPLv3+
- Documentation: https://carmenbianca.gitlab.io/changelogdir
- Source code: https://gitlab.com/carmenbianca/changelogdir
- PyPI: https://pypi.python.org/pypi/changelogdir
- Python: 3.4+
- Author: Carmen Bianca Bakker <carmen@carmenbianca.eu>
changelogdir is a simple utility that allows you to turn directory structures
into changelog files. Every feature/bugfix/whatever gets its own file to list
changes in, thereby avoiding merge conflict crises such as described
`here <https://gitlab.com/gitlab-org/gitlab-ce/issues/17826>`_.
changelogdir is partially inspired by
`Keep a Changelog <http://keepachangelog.com>`_.
A simple example
----------------
Say we have a ``CHANGELOG.md`` in our master branch that looks like this::
# Changelog
## 1.0.0
- Added support for TempleOS.
And Developer A comes along and does the following in their branch::
# Changelog
## 1.0.0
- Added support for TempleOS.
- Deprecated support for Windows.
And Developer B has this in their branch::
# Changelog
## 1.0.0
- Added support for TempleOS.
- Added support for Android.
Then merging the two branches into master causes a merge conflict, and it's just
a needless headache.
changelogdir fixes this by putting those entries into individual files. Thus,
you'd end up with something looking like this::
awesome-project
├── CHANGELOG
│ └── 1.0.0
│ ├── android.md
│ ├── templeos.md
│ └── windows.md
└── .changelogdirrc
``.changelogdirrc`` contains::
[changelogdir]
directory = CHANGELOG
file_extension = md
header = # Changelog
section_header = ## {section_name}
``android.md`` contains::
- Added support for Android.
``templeos.md`` contains::
- Added support for TempleOS.
``windows.md`` contains::
- Deprecated support for Windows.
And when running ``changelogdir``, the following is generated in alphabetical
order of the file names::
~/awesome-project$ changelogdir
# Changelog
## 1.0.0
- Added support for Android.
- Added support for TempleOS.
- Deprecated support for Windows.
Of course, it might make more sense to put those three changes into a single
file called ``platform-changes.md``, but this is merely for demonstration.
Installation
------------
See :doc:`Installation <INSTALLATION>`.
Usage
-----
See :doc:`Usage <USAGE>`.
Why doesn't changelogdir have its changelog in the Python package?
------------------------------------------------------------------
Doing this would require having changelogdir installed to be able to build
itself. There is probably a way around this (just call changelogdir.py
directly), but it'd be really ugly.
As a compromise, it does generate its own changelog when creating and uploading
the docs. See https://carmenbianca.gitlab.io/changelogdir/CHANGELOG.html.
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
changelogdir-2.0.1.tar.gz
(25.8 kB
view hashes)
Built Distribution
Close
Hashes for changelogdir-2.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 68ac6c991e50c242cb4cdcc068199efdf29794aec5ec98b5546d150c3d4e4c64 |
|
MD5 | 0fefd1131b61d45482f197179da8f4e2 |
|
BLAKE2b-256 | 34fb33dd062b474fddb4497e5501e59d3d79ec70c26c02b5505887dc0fa9c3c7 |