Having a file which keeps the version of the project, automatically generates a changelog.md like file containing the info about commits between versions.

changelog_helper.sh

#!/bin/bash

SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"

COMMITS_VERSIONS=$(git log --follow -- "${SCRIPTDIR}/../VERSION" | grep -E '^commit' | sed 's#commit ##g')
NEXT=$(echo -e "$COMMITS_VERSIONS" | head -1)
COMMITS_VERSIONS=$(echo -e "$COMMITS_VERSIONS" | tail -n+2)

for commit in $COMMITS_VERSIONS; do
    VERSION=$(git show ${NEXT}:../pycuebiq/VERSION)
    echo -e "${VERSION}\n----------------\n"
    
    COMMENTS=$(git log ${commit}...${NEXT})
    echo -e "${COMMENTS}\n"
    
    NEXT=${commit}
done