Metadata-Version: 2.4
Name: ghtc
Version: 0.2.2
Summary: ghtc service
Home-page: https://git.meteo.fr/dsi-dev-ws/ghtc
Author: Fabien MARTY
Author-email: fabien.marty@meteo.fr
License: BSD 3
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer
Requires-Dist: mfutil
Requires-Dist: GitPython==3.1.14
Requires-Dist: mflog
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# git_history_to_changelog

[//]: # (automatically generated from https://github.com/metwork-framework/github_organization_management/blob/master/common_files/README.md)

**Status (master branch)**

[![GitHub CI](https://github.com/metwork-framework/git_history_to_changelog/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/metwork-framework/git_history_to_changelog/actions?query=workflow%3ACI+branch%3Amaster)
[![Maintenance](https://raw.githubusercontent.com/metwork-framework/resources/master/badges/maintained.svg)](https://github.com/metwork-framework/resources/blob/master/badges/maintained.svg)




## What is it?

**GHTC** (**G**it **H**istory **T**o **C**hangelog) is yet another tool to generate a
changelog from git history (with [conventional commit spec](https://www.conventionalcommits.org/)).

## Why another tool?

Just because we didn't find an existing tool matching our needs.

## How to use it?

```console
Usage: ghtc [OPTIONS] REPO_ROOT

Arguments:
  REPO_ROOT  the fullpath to the git repository  [required]

Options:
  --tags-regex TEXT               regex to select tags to show on changelog
                                  [default: ^v[0-9]]

  --starting-rev TEXT             starting revision (if not set
                                  ghtc_changelog_start tag if exists, else
                                  first git commit)

  --remove-duplicates-entries / --no-remove-duplicates-entries
                                  if True, remove duplicate entries  [default:
                                  True]

  --unreleased / --no-unreleased  if True, add a section about unreleased
                                  changes  [default: True]

  --include-type TEXT             include (only) given conventional types in
                                  changelog (can be used multiple times, all
                                  types by default), available types: other,
                                  build, chore, style, ci, refactor, test,
                                  docs, perf, fix, feat  [default: ]

  --title TEXT                    [default: CHANGELOG]
  --unreleased-title TEXT         [default: [Unreleased]]
  --help                          Show this message and exit.
```

The generated CHANGELOG is sent to standard output.






## Contributing guide

See [CONTRIBUTING.md](CONTRIBUTING.md) file.



## Code of Conduct

See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file.



## Sponsors

*(If you are officially paid to work on MetWork Framework, please contact us to add your company logo here!)*

[![logo](https://raw.githubusercontent.com/metwork-framework/resources/master/sponsors/meteofrance-small.jpeg)](http://www.meteofrance.com)
