[debhelper-devel] Bug#779471: Bug#779471: dh_installchangelogs: please add CHANGES.md as an upstream changelog

[Axel Beckert]

Hi Jason,

Jason Pleau wrote:
> Several projects that are hosted on Github use markdown files (.md) as their
> README and changelogs.

Yeah, you also see .markdown and .mdwn as suffixes. Not as common as
.md, but still common.

At least the usage of README.md already caused confusion and bug
reports in Debian, see https://bugs.debian.org/678630 -- but since
dh_installdocs doesn't have such an automatism, there's no need to
discuss the best solution for that.

> CHANGES.md is used by a few projects, and it would be nice to have this file
> automatically picked up as an upstream changelog.

I fully agree and have committed and pushed your changes. Thanks for
your contribution.

I've also checked for occurrences of CHANGES.mdwn, CHANGES.markdown,
changelog.mdwn and changelog.markdown and found a few:

CHANGES.mdwn       = 0 Packages: http://codesearch.debian.net/results/path%3ACHANGES.mdwn%20%3D%3D%3D/page_0
CHANGES.markdown   = 1 Package:  http://codesearch.debian.net/results/path%3ACHANGES.markdown%20%3D%3D%3D/page_0
ChangeLog.mdwn     = 0 Packages: http://codesearch.debian.net/results/path%3AChangeLog.mdwn%20%3D%3D%3D/page_0
ChangeLog.markdown = 0 Packages: http://codesearch.debian.net/results/path%3AChangeLog.markdown%20%3D%3D%3D/page_0
HISTORY.mdwn       = 0 Packages: http://codesearch.debian.net/results/path%3AHISTRORY.mdwn%20%3D%3D%3D/page_0
HISTORY.markdown   = 0 Packages: http://codesearch.debian.net/results/path%3AHISTRORY.markdown%20%3D%3D%3D/page_0

(I also checked some other capitalizations of "ChangeLog" and
"HISTORY" which seemed common or at least possible to me. No hits
there either.)

Then I searched a little bit with DuckDuckGo and found indeed some
more occurrences, even by an DD:

https://duckduckgo.com/?q=%22ChangeLog.mdwn%22+-ikiwiki

"history.mdwn" also has a few hits:

https://duckduckgo.com/?q=%22HISTORY.mdwn%22+-ikiwiki+-git-annex

CHANGES.markdown even a few more:

https://duckduckgo.com/?q=%22CHANGES.markdown%22+-ikiwiki+-git-annex+-recentchanges

Another common suffix for such files seem to be "rst" (IIRC
ReStructuredText coming from the Python world):

https://duckduckgo.com/?q=%22CHANGES.rst%22
http://codesearch.debian.net/results/path%3ACHANGES.rst%20hange/page_0

The latter lists 60 current packages. So I'll soon add ".rst" as
changelog suffix to look for, but I'm rather hesitating to add ".mdwn"
or ".markdown".

		Regards, Axel
-- 
 ,''`.  |  Axel Beckert <abe at debian.org>, http://people.debian.org/~abe/
: :' :  |  Debian Developer, ftp.ch.debian.org Admin
`. `'   |  4096R: 2517 B724 C5F6 CA99 5329  6E61 2FF9 CD59 6126 16B5
  `-    |  1024D: F067 EA27 26B9 C3FC 1486  202E C09E 1D89 9593 0EDE