Tell the world about your latest software release
Scala
Pull request Compare This branch is 25 commits behind n8han:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
notes
project
src/main
.gitignore
README.markdown
build.sbt

README.markdown

herald

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

Install herald using conscript:

cs n8han/herald

Notes Specification

Release notes for your project are expected under a notes/ directory in the root of the project that mixes in the posterous.Publish 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 about.markdown 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 project.

Preview

You can preview your release notes for any project by running herald in its base directory. Herald assumes the notes you want to work with are the highest numbered ones in your notes directory.

Publication Target Site

This plugin comes preconfigured to publish to implicit.ly. To be added as a contributor to implicit.ly, send n8han an email with a link to your Scala project if it isn't on github.

Configuring Credentials

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 = me@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.

herald --publish

If the release notes publication is successful, the shortened published URL is displayed and will open in the default broswer.