Watch
1
0
Fork
You've already forked calens
0
mirror of https://github.com/restic/calens.git synced 2026-11-17 03:10:55 +00:00
The restic changelog generator
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2024-04-28 12:10:15 +02:00
.github/workflows bump min go version to 1.15 2023-11-13 09:04:43 +01:00
.gitignore Add .gitignore 2017-12-25 22:02:41 +01:00
.golangci.yml CI: Update jobs using a configuration similar to restic 2023-01-08 12:47:54 +01:00
go.mod fix tests on Go 1.15 2023-11-13 21:58:08 +01:00
go.sum fix tests on Go 1.15 2023-11-13 21:58:08 +01:00
LICENSE Initial commit 2017-12-25 20:47:46 +01:00
main.go fix: support verbatim code-block with syntax specified (#18) 2024-04-28 12:10:15 +02:00
main_test.go fix: support verbatim code-block with syntax specified (#18) 2024-04-28 12:10:15 +02:00
README.md Update README.md (#17) 2023-11-23 18:09:03 +01:00

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.