From: Michael Rienstra <mrienstra@gmail.com>
To: git@vger.kernel.org
Subject: Markdown release notes
Date: Thu, 9 Feb 2023 14:15:59 -0800 [thread overview]
Message-ID: <CABBAUF+acoMScQfHFQGooPx9eng2FBeb-Z2619DsnCt5QmhQPQ@mail.gmail.com> (raw)
Release notes are currently plain text files -- and that option should
surely remain for backwards compatibility -- but it would be nice to
have them in a format that facilitates cross-linking.
For example, https://git-scm.com/ currently shows:
> Latest source Release
> 2.39.1
> Release Notes (2022-12-13)
Which links to:
> Git v2.39.1 Release Notes
> =========================
>
>
> This release merges the security fix that appears in v2.30.7; see
>
> the release notes for that version for details.
-- https://raw.github.com/git/git/master/Documentation/RelNotes/2.39.1.txt
Navigating to the release notes for v2.30.7 is not convenient. Some
users will simply modify the URL, which will do the trick. Others may
find their way to
https://github.com/git/git/tree/master/Documentation/RelNotes & search
for "2.39.1", which also works, but isn't particularly friendly.
Markdown alternative POC for the v2.39.1 release notes:
https://github.com/mrienstra/git/blob/markdown-release-notes-poc/Documentation/RelNotes/2.39.1.md
Now "the security fix that appears in v2.30.7" can be easily followed to:
https://github.com/mrienstra/git/blob/markdown-release-notes-poc/Documentation/RelNotes/2.30.7.md
Along the same lines, CVE IDs could be linked out in Markdown release
notes, I did that in a few cases as part of this POC. For example, in
the v2.30.7 release notes (last link above) there is now a link to:
https://nvd.nist.gov/vuln/detail/CVE-2022-41903
(nvd.nist.gov seemed to be preferred over cve.org, based on a search
of http://public-inbox.org/git)
I used regex search & replace to add these links, sundry details are
in commit messages here:
https://github.com/git/git/compare/master...mrienstra:git:markdown-release-notes-poc
This seems like a simple change with no obvious side effects. I
suppose the Markdown files could be placed in a subfolder to prevent a
jump from 464 files to 928 in one directory.
Thoughts?
next reply other threads:[~2023-02-09 22:16 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-02-09 22:15 Michael Rienstra [this message]
2023-02-09 22:31 ` Markdown release notes brian m. carlson
2023-02-10 0:09 ` Michael Rienstra
2023-02-10 0:12 ` Michael Rienstra
2023-02-10 13:20 ` Ævar Arnfjörð Bjarmason
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CABBAUF+acoMScQfHFQGooPx9eng2FBeb-Z2619DsnCt5QmhQPQ@mail.gmail.com \
--to=mrienstra@gmail.com \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).