https://github.com/restic/calens
The restic changelog generator
https://github.com/restic/calens
Last synced: over 1 year ago
JSON representation
The restic changelog generator
- Host: GitHub
- URL: https://github.com/restic/calens
- Owner: restic
- License: bsd-2-clause
- Created: 2017-12-25T19:47:46.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-28T10:10:15.000Z (about 2 years ago)
- Last Synced: 2025-04-22T13:18:48.038Z (over 1 year ago)
- Language: Go
- Size: 99.6 KB
- Stars: 20
- Watchers: 7
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/restic/restic/tree/master/changelog)
# 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](https://github.com/restic/restic/tree/master/changelog).
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.