You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
piq9117 d75bf08549 surface errors (#25) 3 years ago
app project rename (#8) 3 years ago
nix initial commit 3 years ago
src surface errors (#25) 3 years ago
.gitignore initial commit 3 years ago
.stylish-haskell.yaml initial commit 3 years ago
CHANGELOG.md changelog update (#21) 3 years ago
LICENSE initial commit 3 years ago
Makefile initial commit 3 years ago
README.md readme (#24) 3 years ago
Setup.hs initial commit 3 years ago
default.nix surface errors (#25) 3 years ago
ponere-changelog.cabal surface errors (#25) 3 years ago
release.nix pure nix-shell (#22) 3 years ago
shell.nix pure nix-shell (#22) 3 years ago

README.md

ponere-changelog

How to use

ponere-changelog: Manage CHANGELOG.md file

Usage: ponere-changelog COMMAND
  Use ponere-changelog to manage the CHANGELOG.md

Available options:
  -h,--help                Show this help text
  -v,--version             Show version

Available commands:
  update                   Update CHANGELOG file
  read                     Render CHANGELOG file

How it works

When the commands are ran inside the project directory it will retreive all the commit messages from the last tag all the way to HEAD, then together with the latest tag and date, renders it to CHANGELOG.md as hints. This can serve as clues on what to write on changelog.

Installation with Cabal

Clone the repo

# github repo
git clone https://github.com/taezos/ponere-changelog.git

# taezos repo
git clone https://taezos.org/taezos/ponere-changelog.git

Build and Install

cd ./ponere-changelog
cabal new-build
cabal new-install

This will get installed in ~/.cabal/bin

Installation with Nix

Clone the repo

# github repo
git clone https://github.com/taezos/ponere-changelog.git

# taezos repo
git clone https://taezos.org/taezos/ponere-changelog.git

Install with nix

cd ./ponere-changelog
nix-env -f release.nix -i