Skip to content

Commit f99f2f2

Browse files
hyperthunkhyperthunk
committed
Sort out changelog support
1 parent e1f3385 commit f99f2f2

File tree

11 files changed

+217
-73
lines changed

11 files changed

+217
-73
lines changed

‎Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ all:
1313

1414
ifneq ($(NAME), '')
1515
$(TEMPLATES):
16-
cat ${TEMPLATE_DIR}/$@.md | sed s/@PAGE@/${NAME}/g >> ${ROOT_DIRECTORY}/wiki/${FNAME}.md
16+
cat ${TEMPLATE_DIR}/$@.mdt | sed s/@PAGE@/${NAME}/g >> ${ROOT_DIRECTORY}/wiki/${FNAME}.md
1717
else
1818
$(TEMPLATES):
1919
$(error you need to specify NAME=<name> to run this target)

‎_config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
exclude: [".rvmrc", ".rbenv-version", "README.md", "Rakefile", "changelog.md"]
1+
exclude: [".rvmrc", ".rbenv-version", "README.md", "Rakefile", "static/templates/wikipage.mdt"]
22
lsi: false
33
auto: true
44
pygments: true

‎_includes/nav.html

+1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
</a>
3333
<ul class="dropdown-menu">
3434
<li><a href="/wiki.html">Wiki</a></li>
35+
<li><a href="/changes.html">ChangeLog</a></li>
3536
<li><a href="http://www.haskell.org/haskellwiki/Cloud_Haskell">CH on haskell.org</a></li>
3637
<li><a href="https://github.com/haskell-distributed">Github Repositories</a></li>
3738
<li><a href="https://cloud-haskell.atlassian.net/secure/BrowseProjects.jspa#all">Issue Tracker</a></li>

‎_layouts/changelog.html

+28-20
Original file line numberDiff line numberDiff line change
@@ -13,38 +13,46 @@
1313
<div class="container">
1414
<ul class="breadcrumb">
1515
<li><a href="/">Home</a> <span class="divider">/</span></li>
16-
<li><a href="/changelog.html">ChangeLog</a> <span class="divider">/</span></li>
16+
<li><a href="/changes.html">Changelog</a> <span class="divider">/</span></li>
17+
<li><a href="">{{ page.title }}</a> <spawn class="divider">/</span></li>
1718
</ul>
1819
</div>
1920
<div class="container">
2021
<div class="row">
21-
<div class="span3">
22+
<div class="span3 sidebar">
2223
<div data-spy="affix" data-offset-bottom="290">
2324
<ul class="nav nav-list sidenav">
24-
<li><a href="/changelog.html"><i class="icon-chevron-right"></i> ChangeLog Home</a></li>
25-
{% for page in site.pages | sort: 'title' %}
26-
{% if page.url contains '/changelog/' %}
27-
<li>
28-
<a href="{{ page.feed_url }}"><i class="icon-chevron-right"></i> {{ page.title }}</a>
29-
{{ page.output }}
30-
</li>
31-
{% endif %}
32-
{% endfor %}
33-
</ul>
25+
{% for page in site.pages %}
26+
{% if page.url contains '/changelog/' %}
27+
<li><a href="{{ page.url }}">{{ page.title }}</a></li>
28+
{% endif %}
29+
{% endfor %}
30+
</ul>
3431
</div>
3532
</div>
33+
<div class="span9">
34+
<h4>Version <a href="{{ page.release }}">{{ page.version }}</a></h4>
35+
<h4>Status: {% if page.status contains 'Released' %}
36+
<a href="https://hackage.haskell.org/package/{{ page.title }}">{{ page.status }}</a>
37+
{% else %}
38+
Pending Release
39+
{% endif %}
40+
</h4>
41+
<h4>Due/Released: {{ page.date }}</h4>
42+
<h4><a href="https://github.com/haskell-distributed/distributed-process/compare/{{ page.commits }}">Code Changes (redirects to github)</a></h4>
43+
{{ content }}
44+
<a href="{{ page.feed_url }}"><h5>Issue RSS Feed</h5></a>
45+
</div>
46+
<!--
47+
<div class="span9">
48+
<h4>Upgrading</h4>
49+
TODO: some generic advice about upgrading??
50+
</div>
51+
-->
3652
</div>
3753
</div>
3854
{% include footer.html %}
3955
{% include js.html %}
4056
</body>
4157
</html>
4258

43-
<!--
44-
45-
all comments url
46-
https://cloud-haskell.atlassian.net/sr/jira.issueviews:searchrequest-comments-rss/temp/SearchRequest.xml?jqlQuery=&tempMax=1000
47-
48-
--!>
49-
50-

‎_layouts/changes.html

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
{% include head.html %}
5+
<style>
6+
body { padding-top: 0px; }
7+
.navbar-fixed-top { position: relative !important; }
8+
</style>
9+
<link href="/css/sidenav.css" rel="stylesheet">
10+
</head>
11+
<body data-spy="scroll" data-target=".sidebar"> <!-- data-offset-top="10">-->
12+
{% include nav.html %}
13+
<div class="container">
14+
<ul class="breadcrumb">
15+
<li><a href="/">Home</a> <span class="divider">/</span></li>
16+
<li><a href="/changes.html">Changes</a> <span class="divider">/</span></li>
17+
</ul>
18+
</div>
19+
<div class="container">
20+
<div class="row">
21+
<div class="span3 sidebar">
22+
<div data-spy="affix" data-offset-bottom="290">
23+
<ul class="nav nav-list sidenav">
24+
{% for page in site.pages %}
25+
{% if page.url contains '/changelog/' %}
26+
<li><a href="{{ page.url }}">{{ page.title }}</a></li>
27+
{% endif %}
28+
{% endfor %}
29+
</ul>
30+
</div>
31+
</div>
32+
<div class="span9">
33+
{{ content }}
34+
</div>
35+
</div>
36+
</div>
37+
{% include footer.html %}
38+
{% include js.html %}
39+
</body>
40+
</html>
41+

‎changelog.md

-33
This file was deleted.

‎changelog/dp-0.4.1.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
layout: changelog
3+
title: distributed-process-0.4.1
4+
date: Sun Jan 27 15:12:02 UTC 2013
5+
status: Released
6+
version: 0.4.1
7+
commits: distributed-process-0.4.0.2...distributed-process-0.4.1
8+
hackage: https://hackage.haskell.org/package/distributed-process
9+
---
10+
---------
11+
<h4>Notes</h4>
12+
13+
This is a small feature release containing various enhancements.
14+
15+
---------
16+
<h4>Improvements</h4>
17+
<ul>
18+
<li><a href="https://github.com/haskell-distributed/distributed-process/commit/a5faffd">Update package boundaries </a></li>
19+
<li><a href="https://github.com/haskell-distributed/distributed-process/commit/0f03091">depend on binary-0.6 instead of 0.5</a></li>
20+
<li><a href="https://github.com/haskell-distributed/distributed-process/commit/294e873">Require http-conduit >= 1.8.1</a></li>
21+
<li><a href="https://github.com/haskell-distributed/distributed-process/commit/8b95ef1">Implement receiveChanTimeout</a></li>
22+
<li><a href="https://github.com/haskell-distributed/distributed-process/commit/37b0263">Changed semantics of register/unregister to match Erlang</a></li>
23+
<li><a href="https://github.com/haskell-distributed/distributed-process/commit/24163c2">Fixed de-registration of remote processes when the process terminates</a></li>

‎changelog/dp-0.4.2.md

+23-18
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,39 @@
11
---
22
layout: changelog
33
title: distributed-process-0.4.2
4+
date: Sun Jan 27 15:12:02 UTC 2013
5+
status: Released
6+
version: 0.4.2
7+
commits: distributed-process-0.4.1...v0.4.2
8+
hackage: https://hackage.haskell.org/package/distributed-process
9+
release: https://cloud-haskell.atlassian.net/browse/DP/fixforversion/10006
410
feed_url: https://cloud-haskell.atlassian.net/sr/jira.issueviews:searchrequest-rss/temp/SearchRequest.xml?jqlQuery=project+%3D+DP+AND+status+%3D+Closed+AND+fixVersion+%3D+0.4.2&tempMax=1000
511
---
12+
---------
13+
<h4>Notes</h4>
614

7-
### Release Notes - distributed-process - Version 0.4.2
8-
9-
<h2> Bug
10-
</h2>
15+
This is a small feature release containing process management enhancements and
16+
a new tracing/debugging capability.
17+
18+
---------
19+
<h4>Bugs</h4>
1120
<ul>
12-
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-60'>DP-60</a>] - Fixes made for the distributed-process with strict bytestrings
21+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-60'>DP-60</a>] - Fixes made for the distributed-process with strict bytestrings
1322
</li>
1423
</ul>
15-
16-
<h2> Improvement
17-
</h2>
24+
25+
<h4>Improvements</h4>
1826
<ul>
19-
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-61'>DP-61</a>] - Switched from Binary to cereal, allowed switching between lazy and strict ByteString, fixed some bugs
27+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-61'>DP-61</a>] - Switched from Binary to cereal, allowed switching between lazy and strict ByteString
2028
</li>
21-
</ul>
22-
23-
<h2> Task
24-
</h2>
25-
<ul>
26-
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-31'>DP-31</a>] - Messages from the &quot;main channel&quot; as a receivePort
29+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-31'>DP-31</a>] - Messages from the &quot;main channel&quot; as a receivePort
30+
</li>
31+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-35'>DP-35</a>] - Add variants of exit and kill for the current process
2732
</li>
28-
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-35'>DP-35</a>] - Add variants of exit and kill for the current process
33+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-50'>DP-50</a>] - Support for killing processes
2934
</li>
30-
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-50'>DP-50</a>] - killing processes
35+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-51'>DP-51</a>] - provide local versions of spawnLink and spawnMonitor
3136
</li>
32-
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-51'>DP-51</a>] - provide local versions of spawnLink and spawnMonitor
37+
<li>[<a href="https://cloud-haskell.atlassian.net/browse/DP-13"> - Tracing and Debugging support]
3338
</li>
3439
</ul>

‎changelog/dp-0.5.0.md

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
layout: changelog
3+
title: distributed-process-0.5.0
4+
status: Released
5+
date: Wen May 28 12:15:02 UTC 2014
6+
version: 0.5.0
7+
commits: distributed-process-0.4.2...master
8+
hackage: https://hackage.haskell.org/package/distributed-process
9+
release: https://cloud-haskell.atlassian.net/browse/DP/fixforversion/10008
10+
feed_url: https://cloud-haskell.atlassian.net/sr/jira.issueviews:searchrequest-rss/temp/SearchRequest.xml?jqlQuery=project+%3D+DP+AND+status+%3D+Closed+AND+fixVersion+%3D+0.5.0&tempMax=1000
11+
---
12+
---------
13+
<h4>Notes</h4>
14+
15+
This is a full feature release containing important enhancements to inter-process messaging,
16+
process and node management, debugging and tracing. Various bug-fixes have also been made.
17+
18+
<h5><b>Highlights</b></h5>
19+
20+
New advanced messaging APIs provide broader polymorphic primitives for receiving and processing message
21+
regardless of the underlying (when decoded) types. Extended exit handling capabilities have been added,
22+
to facilitate processing *exit signals* when the *exit reason* could be represented by a variety of
23+
underlying types.
24+
25+
The performance of inter-process messaging has been optimised for intra-node use cases. Messages are no
26+
longer sent over the network-transport infrastructure when the receiving process resides on the same node
27+
as the sender. New `unsafe` APIs have been made available to allow code that uses intra-node messaging to
28+
skip the serialization of messages, facilitating further performance benefits at the risk of altered
29+
error handling semantics. More details are available in the [`UnsafePrimitives` documentation][1].
30+
31+
A new [*Management API*][2] has been added, giving user code the ability to receive and respond to a running
32+
node's internal system events. The tracing and debugging support added in 0.4.2 has been [upgraded][3] to use
33+
this API, which is more efficient and flexible.
34+
35+
---------
36+
37+
<h4>Bugs</h4>
38+
<ul>
39+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-68'>DP-68</a>] - Dependency on STM implicitly changed from 1.3 to 1.4, but was not reflected in the .cabal file</li>
40+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-79'>DP-79</a>] - Race condition in local monitoring when using `call`</li>
41+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-94'>DP-94</a>] - mask does not work correctly if unmask is called by another process</li>
42+
</ul>
43+
44+
<h4>Improvements</h4>
45+
<ul>
46+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-20'>DP-20</a>] - Improve efficiency of local message passing</li>
47+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-77'>DP-77</a>] - nsend should use local communication channels</li>
48+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-39'>DP-39</a>] - Link Node Controller and Network Listener</li>
49+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-62'>DP-62</a>] - Label spawned processes using labelThread</li>
50+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-85'>DP-85</a>] - Relax upper bound on syb in the cabal manifest</li>
51+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-78'>DP-78</a>] - Bump binary version to include 0.7.*</li>
52+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-91'>DP-91</a>] - Move tests to https://github.com/haskell-distributed/distributed-process-tests</li>
53+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-92'>DP-92</a>] - Expose process info</li>
54+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-92'>DP-92</a>] - Expose node statistics</li>
55+
</ul>
56+
57+
<h4>New Features</h4>
58+
<ul>
59+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-7'>DP-7</a>] - Polymorphic expect (see details <a href='https://hackage.haskell.org/package/distributed-process-0.5.0/docs/Control-Distributed-Process.html#g:5'>here</a>)</li>
60+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-57'>DP-57</a>] - Expose Message and broaden the scope of polymorphic expect</li>
61+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-84'>DP-84</a>] - Provide an API for working with internal (system) events</li>
62+
<li>[<a href='https://cloud-haskell.atlassian.net/browse/DP-83'>DP-83</a>] - Report node statistics for monitoring/management</li>
63+
</ul>
64+
65+
66+
[1]: https://hackage.haskell.org/package/distributed-process-0.5.0/docs/Control-Distributed-Process-UnsafePrimitives.html
67+
[2]: https://hackage.haskell.org/package/distributed-process-0.5.0/docs/Control-Distributed-Process-Management.html
68+
[3]: https://hackage.haskell.org/package/distributed-process-0.5.0/docs/Control-Distributed-Process-Debug.html

‎changes.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
layout: changes
3+
title: Changelog
4+
---
5+
6+
### Viewing Changes
7+
8+
Each version of each cloud haskell project has a change log, which can be
9+
viewed by clicking on the links to the left hand side of this page.
10+
11+
### Editing
12+
13+
Editing this page is pretty simple. This entire website is stored in a git
14+
repository and its dynamic content rendered by github pages using [Jekyll][1].
15+
You can clone the repository [here][2]. Instructions for using jekyll are
16+
available [online][1], but in general it's just a matter of finding the right
17+
markdown file. Wiki content is all located in the wiki subfolder.
18+
19+
### Adding new content
20+
21+
We plan to set up a script that pulls the Jira RSS feed and inserts content
22+
here, however for the time being, adding a new page beneath the `changelog`
23+
folder will be sufficient to pull a new version into the navigation menu.
24+
Our Jira instance is set up to produce HTML release notes which can be tweaked
25+
by hand if necessary and the front matter for change-logs can be copied from
26+
one of the existing pages.
27+
28+
29+
[1]: https://github.com/mojombo/jekyll
30+
[2]: https://github.com/haskell-distributed/haskell-distributed.github.com
31+
[3]: https://github.com/mojombo/jekyll/wiki/YAML-Front-Matter

‎static/templates/wikipage.md ‎static/templates/wikipage.mdt

File renamed without changes.

0 commit comments

Comments
 (0)