Package: chachacha
CHACHACHAChachacha changes changelogs. This is a tool you can use to keep your changelog tidy,
following theKeep a Changelogspecification which is the most implemented plugin at the moment.Installationpip install chachachaQuickstartInit a new changelog and then add some changes:chachachainit
chachachaaddedGladtomeetyou
catCHANGELOG.mdSubcommands are modeled fromKeep a Changelogspecification:chachacha--help
Usage:chachacha[OPTIONS]COMMAND[ARGS]...

Options:--filenameTEXTchangelogfilename--driverTEXTchangelogformatdriver--helpShowthismessageandexit.

Commands:initinitializeanewfileconfigconfigurechangelogoptionsreleasereleaseaversionaddedaddan"added"entrychangedadda"changed"entrydeprecatedadda"deprecated"entryfixedadda"fixed"entryremovedadda"removed"entrysecurityadda"security"entrySo you canadd,change,deprecate,fix,removeandsecurity
announceyour changes.KAC format plugin driver heavily depends on Colin Bounouar'skeepachangelog library.Releasing a version is simple as:chachacharelease--help

Usage:main.pyrelease[OPTIONS][SPEC]UpdatethechangelogtoreleaseversionSPEC.SPECshouldeitherbetheversionnumbertoreleaseorthestrings"major","minor"or"patch".

Options:--helpShowthismessageandexit.Specification followsSemantic Versioningthanks to pythonsemver library.ConfigurationStarting from 0.1.3, Chachacha supports a small configuration system directly
embedded in the file via a hack on Markdown link syntax. This allow for
a number of features like generating compare history:chachachainit

chachachaconfiggit_providerGH
chachachaconfigrepo_nameaogier/chachacha
chachachaconfigtag_template'v{t}'chachachaaddedonefeature
chachachaaddedanotherfeature
chachacharelease
chachachasecurityhole
chachachaaddedcapability
catCHANGELOG.md[...]-anotherfeature[Unreleased]:https://github.com/aogier/chachacha/compare/v0.0.1...HEAD[0.0.1]:https://github.com/aogier/chachacha/releases/tag/v0.0.1[//]:# (C3-1-DKAC-GGH-Raogier/chachacha-Tv{t})Configuration system keys are:git_provider: a git repo provider driver (supported:GHfor github.com)repo_name: repo name + namespace your repo istag_template: a tag template which maps release versions with tag names.
Variabletwill be expanded with the version number.ExamplesStart a changelog, add entries and then releasechachachainit# quoting is supportedchachachaadded"this is a new feature I'm excited about"chachachaaddedthisisalsogood
chachachadeprecatedthisisnolongervalidFile is now:catCHANGELOG.md# ChangelogAllnotablechangestothisprojectwillbedocumentedinthisfile.

Theformatisbasedon[KeepaChangelog](https://keepachangelog.com/en/1.0.0/),
andthisprojectadheresto[SemanticVersioning](https://semver.org/spec/v2.0.0.html).## [Unreleased]### Added-thisisanewfeatureI'mexcitedabout
-thisisalsogood### Deprecated-thisisnolongervalid[//]:# (C3-1-DKAC)Now release it:chachacharelease
chachachaaddednewversionaddeditemFile is now:cat CHANGELOG.md

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added

- new version added item

## [0.0.1] - 2020-02-26

### Added

- this is a new feature I'm excited about
- this is also good

### Deprecated

- this is no longer valid

[//]: # (C3-1-DKAC)