herald is a standalone application that automates publishing release notes to any Posterous site, but especially implicit.ly. It transforms notes from Markdown to HTML using Knockoff, and posts them using Dispatch.
Install herald using conscript:
Release notes for your project are expected under a
in the root of the project that mixes in the
trait. In this directory, notes for a particular version are named
<version>.markdown while an optional short description about the
project can be placed in
about.markdown. For example, in
posterous-sbt you'll find the following:
posterous-sbt/ notes/ 0.1.0.markdown 0.1.1.markdown about.markdown
When publishing and previewing, the description from
is appended to the selected version's release notes as boilerplate.
If you're publishing to the Scala software announcement site
implicit.ly, please keep in mind that the post's title will be the
name of your project and its corresponding version: these should not
be repeated as a heading in the notes. It is best to lead with copy
describing the big changes in your release, or jump right into a list
of those changes. For major releases with changes divided into
sections, use an
h3 (a line prefixed by
### in Markdown) or
smaller heading. The short description
about.markdown should be one
or two sentences long, with a link to more information about your
You can preview your release notes for any project by running
in its base directory. Herald assumes the notes you want to work with
are the highest numbered ones in your
Publication Target Site
Set up a password for your email address on Posterous if you haven't
yet, then record it in a java properties file
~/.posterous so that
herald can publish them in your name.
email = email@example.com password = mypassword
Publishing Release Notes
Once you've previewed your source notes and released your project binaries, you're ready to announce to the world.
If the release notes publication is successful, the shortened published URL is displayed and will open in the default broswer.