drewcassidy/yaclog
1
0
Fork 0
mirror of https://github.com/drewcassidy/yaclog.git synced 2024-06-11 01:07:25 +00:00
Code Issues Projects Releases Wiki Activity
8a76bd73eb
yaclog/docs/index.md
drewcassidy 66bc8509e3 Version 1.0.0 
### Changed

- API changes:
  - `header` attribute renamed to `preamble` to avoid confusion.
- improved version header parsing to be more robust and handle multi-word version names.
- improved version number incrementing in `release`.
  - can now handle other text surrounding a pep440-compliant version number, which will not be modified
  - can now handle pre-releases correctly. The version to increment is the most recent version in the log with a valid pep440 version number in it. 
  - Release increment and prerelease increments can be mixed, allowing e.g: `yaclog release -mr` to create a release candidate with in incremented minor version number.
- `release` base version is now an argument instead of an option, for consistency with other commands.

### Removed

- `entry` with multiple `-b` options no longer add sub bullet points, instead adding each bullet as its own line.

### Added

- Terminal output has color to distinguish version names/headers, sections, and git information.
- Extra newlines are added between versions to improve readability of the raw markdown file.
2021-05-07 14:52:28 -07:00

956 B
Raw Blame History

Yaclog: Yet Another Commandline Changelog Tool

Documentation Status Build Status PyPI version

Yaclog is a python library and command line tool to make it easier to keep track of changes to your projects. It includes commands for appending new changes to a markdown changelog file, as well as releasing new versions for deployment via git tags.

---
maxdepth: 2
caption: Contents
---

handbook/index
reference/index

---
maxdepth: 1
---

Changelog <changelog>
License <license>

Indices and tables

  • {ref}genindex
  • {ref}modindex
  • {ref}search