From c445b87a8602e37e1b8091e1fd9ec51012887cd3 Mon Sep 17 00:00:00 2001 From: Lukas Mai Date: Fri, 10 Jan 2025 05:46:25 +0100 Subject: [PATCH] document ChangeLog support on the upload page Fixes #1340. --- datafiles/templates/upload.html.st | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/datafiles/templates/upload.html.st b/datafiles/templates/upload.html.st index b666bad3..9e58b60f 100644 --- a/datafiles/templates/upload.html.st +++ b/datafiles/templates/upload.html.st @@ -36,6 +36,33 @@ of that name and version, including package.cabal. See the notes at the bottom of the page.

+

Version history and change logs

+ +

If a package includes a ChangeLog file (in either plain text or Markdown format), Hackage will link to it on the corresponding package page. The following filenames are recognized:

+ +
+
basename
+
+
    +
  • change_log
    • +
  • changelog
    • +
  • changes
    • +
  • news
    • +
+
+
extension
+
+
    +
  • (none)
    • +
  • .txt
    • +
  • .md
    • +
  • .markdown
    • +
+
+
+ +

ChangeLog names are matched case-insensitively: NEWS, Changes.TXT, and ChangeLog.md will all work.

+

Package versioning and curation

By default, uploaded packages are curated which means that both maintainers and hackage trustees may revise their metadata (particularly involving version bounds) to guide build tools in producing install-plans. (For more information on revisions, see the FAQ).