Skip to main content

ghtc service

Project description

git_history_to_changelog

Status (master branch)

GitHub CI Maintenance

What is it?

GHTC (Git History To Changelog) is yet another tool to generate a changelog from git history (with conventional commit spec).

Why another tool?

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

How to use it?

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 file.

Code of Conduct

See 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ghtc-0.2.0.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

ghtc-0.2.0-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file ghtc-0.2.0.tar.gz.

File metadata

  • Download URL: ghtc-0.2.0.tar.gz
  • Upload date:
  • Size: 8.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.9.1

File hashes

Hashes for ghtc-0.2.0.tar.gz
Algorithm Hash digest
SHA256 9022981ef6b0a9a01d6d8856d8b10b7819b4ebfd95cc5bc92d979404c789c319
MD5 ec08696609fabf4a1caf38d548b853ad
BLAKE2b-256 d3553d70a8944e230b76243fd12c40353b9e5ff83237df3bc857d61bc9e719e7

See more details on using hashes here.

File details

Details for the file ghtc-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: ghtc-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.9.1

File hashes

Hashes for ghtc-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c02a2779f76b0a2ca942cc4a2eae665e51390232b59f7e8baceff2bf44e4ee8b
MD5 b5d1e242c4f8ecaea63b77edf76cb2c4
BLAKE2b-256 5465ceef24904dba3ac40c1141a405ab1c98a712bad8b20299fae58f4a3dfbdc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page