[Owasp-leaders] Fwd: Creating readable ASCII CHANGELOG files from commits to GitHub

Kevin W. Wall kevin.w.wall at gmail.com
Tue Nov 6 02:14:27 UTC 2018


Since I've received nary a response from this, I thought I'd broaden the
mailing list a bit instead of limiting it to OWASP project leaders.

Appreciate any help / suggestions anyone might offer.

---------- Forwarded message ---------
From: Kevin W. Wall <kevin.w.wall at gmail.com>
Date: Sat, Nov 3, 2018 at 5:54 PM
Subject: Creating readable ASCII CHANGELOG files from commits to GitHub
To: OWASP Project Leader List <owasp_project_leader_list at lists.owasp.org>


I think we are finally getting close to an official release of ESAPI for
Java. (Yay! About time, I know.)

My goal is as part of the release to eventually produce some sort of ASCII
release notes, similar to what I did here:
<
https://github.com/ESAPI/esapi-java-legacy/blob/master/documentation/esapi4java-core-2.1.0.1-release-notes.txt
>

The last time I did this, it was mostly a manual process, editing the
results of output from 'git log --oneline' (and some additional args to
restrict the time range), which ended up being both tedious and error
prone, so ideally I would like some automation help in creating the first
part of those release notes descring that part of which GitHub issues have
been closed. The specific format is not as important as the content, but
I'd like to pick up the issue # (as the first field) and the rest of the
commit message and I can then pretty things up as needed manually.

Anyway, as I was looking through various FOSS projects on GitHub, it
appeared that many projects have ASCII CHANGELOG files that I seem to be
90% there, minus perhaps a reference to the GitHub issue #. I googled and
found dozens of tools to help produce CHANGELOG files, but I have no
experience with any of them. I need one that works under Linux and would
prefer a tool set written in either bash, Python, or Perl that I can run
from the command line.

So does anyone have something along those lines that they could recommend
to create a CHANGELOG from the git commit log?

Thanks,
-kevin
--
Blog: http://off-the-wall-security.blogspot.com/  |  Twitter:  @KevinWWall
NSA: All your crypto bit are belong to us.


-- 
Blog: http://off-the-wall-security.blogspot.com/    | Twitter: @KevinWWall
NSA: All your crypto bit are belong to us.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.owasp.org/pipermail/owasp-leaders/attachments/20181105/971c8e06/attachment.html>


More information about the OWASP-Leaders mailing list