Skip to content

document ChangeLog support on the upload page #1357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 27, 2025
Merged

document ChangeLog support on the upload page #1357

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions datafiles/templates/upload.html.st
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,33 @@ of that name and version, including <em>package</em><tt>.cabal</tt>.
See the notes at the bottom of the page.
</p>

<h3 id="changelogs">Version history and change logs</h3>

<p>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:</p>

<dl>
<dt>basename</dt>
<dd>
<ul>
<li><tt>change_log</tt></li>
<li><tt>changelog</tt></li>
<li><tt>changes</tt></li>
<li><tt>news</tt></li>
</ul>
</dd>
<dt>extension</dt>
<dd>
<ul>
<li><em>(none)</em></li>
<li><tt>.txt</tt></li>
<li><tt>.md</tt></li>
<li><tt>.markdown</tt></li>
</ul>
</dd>
</dl>

<p>ChangeLog names are matched case-insensitively: <tt>NEWS</tt>, <tt>Changes.TXT</tt>, and <tt>ChangeLog.md</tt> will all work.</p>

<h3 id="versioning_and_curation">Package versioning and curation</h3>

<p>By default, uploaded packages are <i>curated</i> 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 <a href="https://github.com/haskell-infra/hackage-trustees/blob/master/revisions-information.md">FAQ</A>).
Expand Down