mirror of
https://github.com/restic/calens.git
synced 2026-11-17 03:10:55 +00:00
The restic changelog generator
- Go 100%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
This is useful for renderes that display syntax highlighting based on the type. e.g. see: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting |
||
| .github/workflows | ||
| .gitignore | ||
| .golangci.yml | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| main.go | ||
| main_test.go | ||
| README.md | ||
calens
calens is a changelog generator that nicely prints a changelog file from
a directory with versioned subdirs containing files. A sample directory can be
seen in the restic repository
Installation
To install and run calens locally, run the following commands:
git clone https://github.com/restic/calens.git
cd calens
CGO_ENABLED=0 go install
Creating a Changelog
To create a changlog.md file using calens, change into a repository containing a changelog
folder similar to that of restic.
Then run calens -o changlog.md from within the repository.
When done, open the created changelog to see the generated changelog.
Run calens --help for more options.