Can you recommend a way how to share more detailed release changelog information via GitHub web UI?

Jan Lieskovsky jlieskov at redhat.com
Thu Jan 15 13:54:50 UTC 2015


Hello folks,

  in effort to create new SCAP Security Guide v0.1.20 release and mainly
trying to provide more detailed Changelog information, that would be
reachable online (yet before the actual tarball has been downloaded &
expanded) has been investigating GitHub web UI possibilities for this
purpose.

One approach how this could be implemented is to provide the Changelog
information in the particular milestone's description. But the problem
seems to be there isn't a direct link provided how such milestone's
description could be referenced later.

Example content is visible at:
1) https://github.com/OpenSCAP/scap-security-guide/milestones

   to get the list of milestones

2) then click the "(more)" pseudo link below
   "Version 0.1.20: USGCB profile remediation and kickstart support"
   milestone to see the actual description.

>From what I have searched looks this "(more)" pseudo link is handled
by JavaScript (thus at the side of the client's browser) and it's not
possible to use it for referential purposes.

The vision behind future SCAP Security Guide updates is to provide
also more detailed Changelog information for each release, basically
split into three sections:

  * New Features:

  This not so much detailed section would be dedicated to briefly list
  main new features expected to be provided in this release (like support
  of new products etc.)

  * Enhancements:

  Here list of enhancements would be detailed (IOW enhancements for existing
  products like new remediations or new OVAL checks).

  * Bug fixes:

  Here list of bug fixes would be described (which build failures / OVAL checks /
  remediations have been corrected in this release).

Given (after the short review so far) the GitHub's milestone's description doesn't
seem to be providing functionality for this kind of "web Changelog" was thinking
of creating new GitHub SCAP Security Guide wiki page for each of the new releases
and detailing that information there.

But prior doing that wanted to check experiences of other people / other ideas /
suggestions, how this could be implemented.

Comments / recommendations / experience / proposals welcome.

Thank you && Regards, Jan.
--
Jan iankko Lieskovsky / Red Hat Security Technologies Team


More information about the scap-security-guide mailing list