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.
Source Distribution
File details
Details for the file pre_commit_hooks_changelog-0.1.5.tar.gz
.
File metadata
- Download URL: pre_commit_hooks_changelog-0.1.5.tar.gz
- Upload date:
- Size: 3.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d3716c12c33bfecdcac5fb734b62f47ce5678600c96dc75958f1464b8fd15867 |
|
MD5 | 407d31e6b3d845e117c0ee513e1aa384 |
|
BLAKE2b-256 | 7f10ef683e9164f881091f38e5f9593af86024a9d78f339dd39acb472a4f5e69 |