Skip to main content

generate Changelog.md from yaml files in changelog folder

Project description

pre-commit-hooks-changelog

generate a markdown changelog from folder of yaml files

Using pre-commit-hooks-changelog with pre-commit

Add this to your .pre-commit-config.yaml

-   repo: https://github.com/chrysa/pre-commit-hooks-changelog
    rev: v0.1.0  # Use the ref you want to point at
    hooks:
    -   id: generate-changelog
        files: 'changelog/.*(?<!\.yaml|.yml)$'

Options

--output-file define changelog outpout
--changelog-folder source folder of changelogs
--rebuild rebuild changelog see below

Rebuild options

all rebuild changelog from scratch
versions rebuild changelog for each version
latest rebuild latest changelog
home rebuild changelog file on repo root

Standalone

pip install pre-commit-hooks-changelog

Changelog

Project details


Download files

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

Files for pre-commit-hooks-changelog, version 0.1.5
Filename, size File type Python version Upload date Hashes
Filename, size pre_commit_hooks_changelog-0.1.5.tar.gz (3.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page