Skip to content

A python tool which helps with changelog/release file conflicts with git

License

Notifications You must be signed in to change notification settings

EricHorvat/gitEasyChangelog

Repository files navigation

Git Easy Changelog

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.

Usage

Basic Usage

  1. Install by pip install giteasychangelog.
  2. Create a CHANGELOG folder.
  3. Create a folder for the next version.
  4. Add a new .md single line file for each change that should be reported.
  5. Run giteasychangelog
  6. 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 giteasychangelog

Credits

This package was created with Cookiecutter_ and the audreyr/cookiecutter-pypackage_ project template.

Cookiecutter
audreyr/cookiecutter-pypackage

About

A python tool which helps with changelog/release file conflicts with git

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published