A python tool which helps whit changelog/release file conflicts with git
Project description
# Git Easy Changelog
[![](https://img.shields.io/pypi/v/giteasychangelog.svg)](https://img.shields.io/pypi/v/giteasychangelog)
[![](https://img.shields.io/travis/EricHorvat/giteasychangelog.svg)](https://img.shields.io/travis/EricHorvat/giteasychangelog)
[![](https://readthedocs.org/projects/giteasychangelog/badge/?version=latest)](https://readthedocs.org/projects/giteasychangelog/badge/?version=latest)
[![](https://pyup.io/repos/github/EricHorvat/giteasychangelog/shield.svg)](https://pyup.io/repos/github/EricHorvat/giteasychangelog/)
This project helps at managing yours REALEASE/CHANGELOG `.md` files, avoiding git conflicts as it use one file per
change reported in the final release file.
**Up to the moment**, this is **_not_** a python package.
## Usage
### Basic Usage
1. Download the repository content, and extract it at a new `CHANGELOG` folder.
1. Remove the `example` folder.
1. Create a folder for the next version.
1. Add a new `.md` single line file for each change that should be reported.
1. Run `summarise.py`
1. Go back to step 3.
### Advanced options
* You can change previous version files, up to error, reference of newest changes or anything you want.
* You can add a `date.md` file in any version file, which will be add as release date reference.
#### Example
You can test the project in `example` branch, by simple running `summarise.py`
####Credits
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
[Cookiecutter](https://github.com/audreyr/cookiecutter)
[audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage)
New features in the latest update
=====================================
0.1.0 [Feb 18th, 2019]:
---
* First release of the tool!
* Usable as a cli command!
* Function as describe in README!
[![](https://img.shields.io/pypi/v/giteasychangelog.svg)](https://img.shields.io/pypi/v/giteasychangelog)
[![](https://img.shields.io/travis/EricHorvat/giteasychangelog.svg)](https://img.shields.io/travis/EricHorvat/giteasychangelog)
[![](https://readthedocs.org/projects/giteasychangelog/badge/?version=latest)](https://readthedocs.org/projects/giteasychangelog/badge/?version=latest)
[![](https://pyup.io/repos/github/EricHorvat/giteasychangelog/shield.svg)](https://pyup.io/repos/github/EricHorvat/giteasychangelog/)
This project helps at managing yours REALEASE/CHANGELOG `.md` files, avoiding git conflicts as it use one file per
change reported in the final release file.
**Up to the moment**, this is **_not_** a python package.
## Usage
### Basic Usage
1. Download the repository content, and extract it at a new `CHANGELOG` folder.
1. Remove the `example` folder.
1. Create a folder for the next version.
1. Add a new `.md` single line file for each change that should be reported.
1. Run `summarise.py`
1. Go back to step 3.
### Advanced options
* You can change previous version files, up to error, reference of newest changes or anything you want.
* You can add a `date.md` file in any version file, which will be add as release date reference.
#### Example
You can test the project in `example` branch, by simple running `summarise.py`
####Credits
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
[Cookiecutter](https://github.com/audreyr/cookiecutter)
[audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage)
New features in the latest update
=====================================
0.1.0 [Feb 18th, 2019]:
---
* First release of the tool!
* Usable as a cli command!
* Function as describe in README!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
giteasychangelog-0.1.0.tar.gz
(21.5 kB
view hashes)
Built Distribution
Close
Hashes for giteasychangelog-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 21c1f472e9d54939b313f3046888c06aea349d15fa882341ceed82d8fafea62b |
|
MD5 | cb5c3d93df08b5ead01fa826a85fa5cf |
|
BLAKE2b-256 | 1a4c88fc1177d9e4231cd424ac9246ff959edc783673efe30a7ac3b45c83d8e0 |